<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow: net_flow/event_set.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow<span id="projectnumber">&#160;2.0.0</span>
   </div>
   <div id="projectbrief">Flow project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_460afd45d0ec637b1427e0e06a6fbcf7.html">net_flow</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">event_set.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="event__set_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/* Flow</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * Copyright 2023 Akamai Technologies, Inc.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> *</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> * Licensed under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> * &quot;License&quot;); you may not use this file except in</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> * compliance with the License.  You may obtain a copy</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> * of the License at</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> *</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> *   https://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> *</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> * Unless required by applicable law or agreed to in</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> * writing, software distributed under the License is</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> * distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"> * CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment"> * See the License for the specific language governing</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment"> * permissions and limitations under the License. */</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment"></span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment">/// @file</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment"></span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="preprocessor">#include &quot;<a class="code" href="net__flow__fwd_8hpp.html">flow/net_flow/net_flow_fwd.hpp</a>&quot;</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="preprocessor">#include &quot;<a class="code" href="net__flow_2error_2error_8hpp.html">flow/net_flow/error/error.hpp</a>&quot;</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="preprocessor">#include &quot;<a class="code" href="traits_8hpp.html">flow/util/traits.hpp</a>&quot;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="preprocessor">#include &quot;<a class="code" href="shared__ptr__alias__holder_8hpp.html">flow/util/shared_ptr_alias_holder.hpp</a>&quot;</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="preprocessor">#include &lt;boost/shared_ptr.hpp&gt;</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span><span class="preprocessor">#include &lt;boost/enable_shared_from_this.hpp&gt;</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span><span class="preprocessor">#include &lt;boost/any.hpp&gt;</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span> </div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceflow_1_1net__flow.html">flow::net_flow</a></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span>{</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="comment">// Types.</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="comment"></span> </div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="comment">/**</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span><span class="comment"> * A user-set collection of sockets and desired conditions on those sockets (such as: &quot;socket has data</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span><span class="comment"> * to read&quot;), with the ability to wait for those conditions to become true and signal the user when so.</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span><span class="comment"> *</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span><span class="comment"> * @note Important: With the somewhat more recent availability of the asio::Node hierarchy, which slickly adds</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span><span class="comment"> *       boost.asio-event-loop-integration to the Node hierarchy, public use of this class Event_set should be avoided</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span><span class="comment"> *       for those already using a boost.asio event loop.  It is both significantly simpler -- and a bit faster --</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span><span class="comment"> *       to use Peer_socket::async_send(), Server_socket::async_accept(), etc. -- as well as a bit faster.</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span><span class="comment"> *       IN PARTICULAR, the complex discussion in Event_set doc header regarding async_wait() with a glue socket</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span><span class="comment"> *       is something one should skip over if one could just integrate directly into a boost.asio loop.</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span><span class="comment"> * @note Advice: Even if you don&#39;t already use a boost.asio event loop, consider doing so before giving up and going for</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span><span class="comment"> *       an Event_set glue pattern as described in this class doc header.  Your application may be sigificantly simpler</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span><span class="comment"> *       and more maintainable as a result.</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span><span class="comment"> * @note Advice: In general, please read the bird&#39;s eye view of the entire set of I/O ops in `net_flow`; this is found</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span><span class="comment"> *       in asio::Node doc header.  This should help hugely in choosing the right type of operating mode in the context</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span><span class="comment"> *       of a non-trivial application, possibly featuring other types of I/O in addition to the Flow protocol.</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span><span class="comment"> * @note All that said, Event_set is a very important facility and is, at the very least, built-upon internally for all</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span><span class="comment"> *       but the basic non-blocking ops.  Advanced users should understand it (even if they don&#39;t use it directly).</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span><span class="comment"> *</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span><span class="comment"> * This fulfills the same role as BSD sockets&#39; `select()` (and its more powerful non-portable</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span><span class="comment"> * equivalents like epoll, kqueue, etc.).  In addition to the feature set provided by functions such</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span><span class="comment"> * as `select()`, Event_set provides a way to work together with the OS&#39;s built-in `select()`</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span><span class="comment"> * equivalent; that is to say it provides a way to add Flow-protocol sockets into an event loop written in</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span><span class="comment"> * terms of `select()` or spritiually similar facilities (epoll, kqueue, etc.).</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span><span class="comment"> *</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span><span class="comment"> * The simplest way to use Event_set is to not use it directly at all.  Instead, use the blocking</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span><span class="comment"> * methods such as Peer_socket::sync_receive(), Peer_socket::sync_send(), Node::sync_connect(), and</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span><span class="comment"> * Server_socket::sync_accept().  Such methods will internally construct an Event_set with the</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span><span class="comment"> * target socket and perform work (namely some Event_set::sync_wait() calls) on it, hidden from the caller.</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span><span class="comment"> * This mode of operation is analogous to BSD sockets&#39; blocking functions (e.g., `recv()` in blocking</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span><span class="comment"> * mode -- POSIX `O_NONBLOCK` bit set / WinSock `FIONBIO` mode is enabled).</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span><span class="comment"> *</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span><span class="comment"> * This is often insufficient, as in event loops of any complexity.  The next simplest way to use</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span><span class="comment"> * Event_set is to use a synchronous wait.  To do so, construct an Event_set, add the desired</span></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span><span class="comment"> * &lt;em&gt;(socket, desired event on that socket)&lt;/em&gt; pairs to it (see the swap_wanted_sockets(), add_wanted_socket(),</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span><span class="comment"> * remove_wanted_socket() methods), then perform sync_wait() (with an optional timeout).  Once that method</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span><span class="comment"> * returns (which happens once either 1 or more events are active, there is a timeout, or wait is</span></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span><span class="comment"> * interrupted via Node::interrupt_all_waits()), examine which events (if any) were found to be active, then perform</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span><span class="comment"> * the appropriate operation (e.g., `serv-&gt;accept()` if Acceptable, `sock-&gt;send()` if Writable) on each active</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span><span class="comment"> * socket/event pair.  This mode of operation is analogous to `FD_SET(); select(); FD_ISSET()` or</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span><span class="comment"> * `epoll_ctl(); epoll_wait()`.  The key feature is that the sync_wait() (like `select()` or `epoll_wait()`) call blocks</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span><span class="comment"> * the calling thread until there are events or a timeout or a global interrupt (the latter similar to POSIX `EINTR`</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span><span class="comment"> * caused by a signal).  Additionally, the Event_set::poll() method is analogous to a `select()` call with a 0 timeout.</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span><span class="comment"> *</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span><span class="comment"> * The above is sufficient when writing an event loop that works *only* with Flow-protocol sockets.  However,</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span><span class="comment"> * many practical applications will use an event loop that works with Flow-protocol sockets and other</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span><span class="comment"> * resources (e.g., TCP sockets, pipes) simultaneously.  Then what?</span></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span><span class="comment"> *   - If you have a boost.asio event loop, then (again) the best way to use Event_set is by not using it directly;</span></div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span><span class="comment"> *     instead use asio::Node hierarchy to use Flow-protocol sockets as 1st-class-citizen boost.asio-style I/O objects.</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span><span class="comment"> *     Internally, again, an Event_set will be indirectly used; but one would not use it directly.</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span><span class="comment"> *   - Otherwise -- if there is no boost.asio event loop, and it&#39;s impractical to convert to using one (generally a</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span><span class="comment"> *     a good idea but may not be practical under time constraints), then direct use the core Event_set feature</span></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span><span class="comment"> *     (namely Event_set::async_wait()) is just the ticket.</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span><span class="comment"> *</span></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span><span class="comment"> * We now discuss Event_set::async_wait().  The basic deficiency of sync_wait() is simply that it will only wake up</span></div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span><span class="comment"> * if there&#39;s a Flow-protocol event and knows nothing about anything</span></div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span><span class="comment"> * else.  Similarly, your `select()`-or-equivalent-of-choice</span></div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span><span class="comment"> * will know nothing of Flow-protocol events, since it can only work with standard file descriptors</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span><span class="comment"> * (or whatever), not Flow sockets.  For this case Event_set provides asynchronous waiting.  As</span></div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span><span class="comment"> * before, you&#39;ll construct an Event_set and add some desired sockets/events.  Then, call</span></div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span><span class="comment"> * `async_wait(F)`, where `F()` is a function.  async_wait() will IMMEDIATELY return.  However, another,</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span><span class="comment"> * unspecified, thread will wait for the desired condition(s) to become true.  Once that occurs,</span></div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span><span class="comment"> * that unspecified thread will call `F()`.  `F()` can do whatever you want (but see restrictions</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span><span class="comment"> * documented on async_wait()); however in the use case described in this paragraph it will probably</span></div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span><span class="comment"> * want to do something that will wake up the `select()` (or `epoll_wait()`, or ...) of your main event</span></div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span><span class="comment"> * loop.  For example, you can set up a Unix domain socket or pipe and add it into your `select()` (or</span></div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span><span class="comment"> * equivalent&#39;s) event set; and then have `F()` write 1 byte to it.  Once this occurs, that `select()`</span></div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span><span class="comment"> * (etc.) will wake up; you can call `async_wait_finish()` and then check the active Flow-protocol events using</span></div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span><span class="comment"> * the same techniques as shown in the preceding paragraph, after having called sync_wait().</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span><span class="comment"> *</span></div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span><span class="comment"> * The following illustrates the preceding paragraph.  In this example, we are interested in a single TCP</span></div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span><span class="comment"> * socket from which to read; and a single Flow socket from which to read.  This can be extended to more</span></div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span><span class="comment"> * native and Flow socket types, more sockets, and more sophisticated native mechanisms than `select()`;</span></div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span><span class="comment"> * but basically this is it.  (However, in case of `select()` and its peculiar `FD_SET()` semantics, please</span></div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span><span class="comment"> * note that this examples combines `sel_read_set` to handle both the special local &quot;linking&quot; socket `comm_sock`</span></div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span><span class="comment"> * and the TCP-readable socket `tcp_sock`.  If you want to check for another type of event than being &quot;readable&quot; --</span></div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span><span class="comment"> * e.g., &quot;writable&quot; -- then with `select()` you&#39;d need to make a separate event set, perhaps named `sel_write_set`,</span></div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span><span class="comment"> * and it would not be handling `comm_sock`, in whose case we only care about readability.  Note also that</span></div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span><span class="comment"> * the example event loop iteration shown below models situation where `tcp_sock` and `flow_sock` happen to</span></div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span><span class="comment"> * both become readable just about at the same time, causing `select()` to return with 2 sockets in readable state</span></div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno">  113</span><span class="comment"> * simultaneously for illustration purposes.  Realistically probably one would become readable; then in another</span></div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span><span class="comment"> * loop iteration the other would... but this would be annoyingly lengthy to show; and though this is less</span></div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span><span class="comment"> * probable, it&#39;s still possible.</span></div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span><span class="comment"> *</span></div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno">  117</span><span class="comment"> *   ~~~</span></div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno">  118</span><span class="comment"> *   // NOTE: ASCII art arrows |--------&gt; (etc.) indicate thread execution.  &quot;U&quot; is the user thread.</span></div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno">  119</span><span class="comment"> *   //       &quot;K&quot; is unspecified kernel &quot;thread.&quot;  &quot;W&quot; is unspecified `net_flow` working thread.</span></div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno">  120</span><span class="comment"> *   //       T (cont.) just means thread T was already running up to the point we are illustrating.</span></div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno">  121</span><span class="comment"> *</span></div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno">  122</span><span class="comment"> *   U (cont.)</span></div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno">  123</span><span class="comment"> *   | Set up local socket (e.g., Unix domain socket or localhost TCP socket) comm_sock.</span></div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno">  124</span><span class="comment"> *   | Set up select() native socket set sel_read_set, for native &quot;readable&quot; events.</span></div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno">  125</span><span class="comment"> *   | Set up net_flow::Event_set flow_set.</span></div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno">  126</span><span class="comment"> *   | FD_SET(comm_sock, sel_read_set);</span></div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno">  127</span><span class="comment"> *   | Set up native TCP peer socket tcp_sock.</span></div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno">  128</span><span class="comment"> *   | Set up Flow peer socket flow_sock.</span></div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno">  129</span><span class="comment"> *   | FD_SET(tcp_sock, sel_read_set);</span></div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno">  130</span><span class="comment"> *   | flow_set.add_wanted_socket(flow_sock, Event_type::S_PEER_SOCKET_READABLE);</span></div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno">  131</span><span class="comment"> *   | Event loop begins here. &lt;--------------------------------------+ K (cont.)             W (cont.)</span></div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno">  132</span><span class="comment"> *   |   flow_set.async_wait(handle_flow_ev);                         | | ...                 | ...</span></div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno">  133</span><span class="comment"> *   |     Inform W. -&gt;                                               | | ...                 | flow_set -&gt; WAITING.</span></div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno">  134</span><span class="comment"> *   |   select(2, sel_read_set, NULL, NULL, ...positive-timeout...); | | ...                 | ...</span></div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno">  135</span><span class="comment"> *   |     ...select() blocking...                                    | | ...                 | ...</span></div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno">  136</span><span class="comment"> *   |     ...                                                        | | ...                 | ...</span></div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno">  137</span><span class="comment"> *   |     ...                                                        | | tcp_sock readable!  | ...</span></div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno">  138</span><span class="comment"> *   |     ...                                                        | | &lt;- Tell select().   |</span></div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno">  139</span><span class="comment"> *   |     K says tcp_sock readable! Get ready to return!             | | ...                 | flow_sock readable!</span></div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno">  140</span><span class="comment"> *   |                                                                | |                     | handle_flow_ev():</span></div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno">  141</span><span class="comment"> *   |                                                                | |                     |   Write 1 -&gt; comm_sock.</span></div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno">  142</span><span class="comment"> *   |                                                                | | comm_sock readable! |</span></div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno">  143</span><span class="comment"> *   |                                                                | | &lt;- Tell select().   |</span></div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno">  144</span><span class="comment"> *   |     K says comm_sock readable, and that&#39;s it.  Return!         | | ...                 | ...</span></div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno">  145</span><span class="comment"> *   |   flow_set.async_wait_finish();                                | v                     | ...</span></div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno">  146</span><span class="comment"> *   |     Inform W. -&gt;                                               |                       | ...</span></div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno">  147</span><span class="comment"> *   |   if (FD_ISSET(tcp_sock, sel_read_set))                        |                       | flow_set -&gt; INACTIVE.</span></div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno">  148</span><span class="comment"> *   |     Non-blocking recv(tcp_sock) until exhausted!               |                       v</span></div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno">  149</span><span class="comment"> *   |   if (FD_ISSET(comm_sock, sel_read_set))                       |</span></div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno">  150</span><span class="comment"> *   |     In this example we&#39;ve only 1 Flow socket and event, so: \  |</span></div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno">  151</span><span class="comment"> *   |     flow_sock.async_receive() until exhausted!                 |</span></div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno">  152</span><span class="comment"> *   | Event loop ends here. -----------------------------------------+</span></div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno">  153</span><span class="comment"> *   v</span></div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno">  154</span><span class="comment"> *   ~~~</span></div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno">  155</span><span class="comment"> *</span></div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno">  156</span><span class="comment"> * The above are informal suggestions for use.  Here is the more formal description of operation of</span></div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno">  157</span><span class="comment"> * an Event_set.  Event_set is a simple state machine with three states: INACTIVE, WAITING, CLOSED.</span></div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno">  158</span><span class="comment"> * After construction (which is done by Node in a factory fashion), Event_set is in INACTIVE state.</span></div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno">  159</span><span class="comment"> * CLOSED means the Event_set has been Event_set::close()d, or the originating Node has been destroyed.  It is</span></div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno">  160</span><span class="comment"> * not possible to perform any operations on a CLOSED Event_set, nor is it possible to exit the CLOSED</span></div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno">  161</span><span class="comment"> * state.  A CLOSED Event_set stores no resources and will be deleted via `shared_ptr&lt;&gt;` mechanics</span></div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno">  162</span><span class="comment"> * once all user references to it are gone.</span></div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno">  163</span><span class="comment"> *</span></div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno">  164</span><span class="comment"> * The rest of the time, Event_set switches back and forth between INACTIVE and WAITING.  In</span></div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno">  165</span><span class="comment"> * INACTIVE, you may set and examine the desired sockets/events.  The following are supported (see also</span></div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno">  166</span><span class="comment"> * Event_set::Event_type `enum` values)</span></div>
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno">  167</span><span class="comment"> *</span></div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno">  168</span><span class="comment"> *   - &lt;em&gt;Peer_socket Readable&lt;/em&gt;: true if and only if `sock-&gt;receive()` with unlimited target buffer</span></div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno">  169</span><span class="comment"> *     space would return either a non-zero number of bytes or indicate an error.  (Therefore &quot;not Readable&quot;</span></div>
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno">  170</span><span class="comment"> *     means it would return 0 but no error.)</span></div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno">  171</span><span class="comment"> *   - &lt;em&gt;Peer_socket Writable&lt;/em&gt;: same but with `sock-&gt;send()`.  Note, however, that typically this is</span></div>
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno">  172</span><span class="comment"> *     more likely to be immediately true on a given socket; if there&#39;s space in the Send buffer for a certain</span></div>
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno">  173</span><span class="comment"> *     small amount of data, then the socket owning it is Writable; whereas data have to actually have arrived</span></div>
<div class="line"><a id="l00174" name="l00174"></a><span class="lineno">  174</span><span class="comment"> *     from the other side for it to be Readable.  Nevertheless, if network conditions are such that the</span></div>
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno">  175</span><span class="comment"> *     Send buffer cannot be purged via sending its contents to the other side, then eventually it won&#39;t be</span></div>
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno">  176</span><span class="comment"> *     Writable either (so don&#39;t count on writability without checking).</span></div>
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno">  177</span><span class="comment"> *   - &lt;em&gt;Server_socket Acceptable&lt;/em&gt;: true if and only if `serv-&gt;accept()` would return either a non-null</span></div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno">  178</span><span class="comment"> *     Server_socket::Ptr or indicate an error.  (Therefore &quot;not Acceptable&quot; means it would return</span></div>
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno">  179</span><span class="comment"> *     null but no error.)</span></div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno">  180</span><span class="comment"> *</span></div>
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno">  181</span><span class="comment"> * The desired events can be specified with swap_wanted_sockets(), add_wanted_socket(),</span></div>
<div class="line"><a id="l00182" name="l00182"></a><span class="lineno">  182</span><span class="comment"> * and remove_wanted_socket().  Note that all of these methods are efficient (no copying</span></div>
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno">  183</span><span class="comment"> * of socket sets involved).  Also note that all the socket objects passed to an Event_set must come</span></div>
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno">  184</span><span class="comment"> * from the same Node as that Event_set; else behavior is undefined.</span></div>
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno">  185</span><span class="comment"> *</span></div>
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno">  186</span><span class="comment"> * Also in INACTIVE, you may examine the results of the last wait, if any.  Do this using</span></div>
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno">  187</span><span class="comment"> * emit_result_sockets(), etc.  Note that these methods are also efficient (no copying) and can</span></div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno">  188</span><span class="comment"> * only be used once for each wait (all subsequent uses yield empty socket sets).</span></div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno">  189</span><span class="comment"> *</span></div>
<div class="line"><a id="l00190" name="l00190"></a><span class="lineno">  190</span><span class="comment"> * In WAITING state, a wait for the specified events has started.  async_wait(), sync_wait(), and</span></div>
<div class="line"><a id="l00191" name="l00191"></a><span class="lineno">  191</span><span class="comment"> * poll() change state from INACTIVE to WAITING.  In WAITING state, all of the above methods return</span></div>
<div class="line"><a id="l00192" name="l00192"></a><span class="lineno">  192</span><span class="comment"> * errors.  The following pieces of code change state back to INACTIVE: async_wait_finish(),</span></div>
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno">  193</span><span class="comment"> * sync_wait() (once an event is true, or timeout), poll() (immediately), and an unspecified</span></div>
<div class="line"><a id="l00194" name="l00194"></a><span class="lineno">  194</span><span class="comment"> * non-user thread if async_wait() was used, and an event has been asynchronously detected.</span></div>
<div class="line"><a id="l00195" name="l00195"></a><span class="lineno">  195</span><span class="comment"> *</span></div>
<div class="line"><a id="l00196" name="l00196"></a><span class="lineno">  196</span><span class="comment"> * In particular, if `Event_set e` is used by 1 thread, and that thread performs only sync_wait()s for</span></div>
<div class="line"><a id="l00197" name="l00197"></a><span class="lineno">  197</span><span class="comment"> * waiting, user code will never be able to observe the WAITING state, as sync_wait() will go</span></div>
<div class="line"><a id="l00198" name="l00198"></a><span class="lineno">  198</span><span class="comment"> * INACTIVE-&gt;WAITING-&gt;INACTIVE internally.</span></div>
<div class="line"><a id="l00199" name="l00199"></a><span class="lineno">  199</span><span class="comment"> *</span></div>
<div class="line"><a id="l00200" name="l00200"></a><span class="lineno">  200</span><span class="comment"> * ### Relationship between 2 different Event_set objects ###</span></div>
<div class="line"><a id="l00201" name="l00201"></a><span class="lineno">  201</span><span class="comment"> * They are entirely independent.  In particular, you</span></div>
<div class="line"><a id="l00202" name="l00202"></a><span class="lineno">  202</span><span class="comment"> * may put the same socket+event combo into 2 different Event_set objects and wait on both Event_sets</span></div>
<div class="line"><a id="l00203" name="l00203"></a><span class="lineno">  203</span><span class="comment"> * simultaneously.  If that socket/event holds for both Event_set objects at the same time, both will</span></div>
<div class="line"><a id="l00204" name="l00204"></a><span class="lineno">  204</span><span class="comment"> * be signalled.  I informally recommend against using this.  For example, if the event is &quot;sock is</span></div>
<div class="line"><a id="l00205" name="l00205"></a><span class="lineno">  205</span><span class="comment"> * Readable,&quot; and you will `receive()` as a result, which of the two `receive()` calls gets what data?</span></div>
<div class="line"><a id="l00206" name="l00206"></a><span class="lineno">  206</span><span class="comment"> * However there may be a reasonable use case for the Acceptable event.</span></div>
<div class="line"><a id="l00207" name="l00207"></a><span class="lineno">  207</span><span class="comment"> *</span></div>
<div class="line"><a id="l00208" name="l00208"></a><span class="lineno">  208</span><span class="comment"> * ### Signals and interruption ###</span></div>
<div class="line"><a id="l00209" name="l00209"></a><span class="lineno">  209</span><span class="comment"> * Any POSIX blocking function, once it has started waiting, will exit with `errno == EINTR`</span></div>
<div class="line"><a id="l00210" name="l00210"></a><span class="lineno">  210</span><span class="comment"> * if a signal is delivered.  (Sometimes this is just annoying, but sometimes it&#39;s useful: if SIGTERM</span></div>
<div class="line"><a id="l00211" name="l00211"></a><span class="lineno">  211</span><span class="comment"> * handler sets some global terminate flag, then the signal delivery will immediately break out of</span></div>
<div class="line"><a id="l00212" name="l00212"></a><span class="lineno">  212</span><span class="comment"> * the blocking call, so the flag can be immediately checked by the main code (and then the program</span></div>
<div class="line"><a id="l00213" name="l00213"></a><span class="lineno">  213</span><span class="comment"> * can cleanly exit, for example).)  Event_set::sync_wait() and Event_set::async_wait() support</span></div>
<div class="line"><a id="l00214" name="l00214"></a><span class="lineno">  214</span><span class="comment"> * similar functionality.  Call Node::interrupt_all_waits() to interrupt any Event_set object(s) within</span></div>
<div class="line"><a id="l00215" name="l00215"></a><span class="lineno">  215</span><span class="comment"> * that Node currently in WAITING state.  They enter INACTIVE state, and it is indicated to the</span></div>
<div class="line"><a id="l00216" name="l00216"></a><span class="lineno">  216</span><span class="comment"> * user of each sync_wait() or async_wait() that the reason for the wait&#39;s finish was an interruption</span></div>
<div class="line"><a id="l00217" name="l00217"></a><span class="lineno">  217</span><span class="comment"> * (see those functions for details on how this is communicated).  Conceptually this is similar to</span></div>
<div class="line"><a id="l00218" name="l00218"></a><span class="lineno">  218</span><span class="comment"> * POSIX blocking `select()` or blocking `recv()` returning -1/`EINTR`.</span></div>
<div class="line"><a id="l00219" name="l00219"></a><span class="lineno">  219</span><span class="comment"> *</span></div>
<div class="line"><a id="l00220" name="l00220"></a><span class="lineno">  220</span><span class="comment"> * To actually cause signals to trigger Node::interrupt_all_waits() (as occurs by default,</span></div>
<div class="line"><a id="l00221" name="l00221"></a><span class="lineno">  221</span><span class="comment"> * conceptually, in POSIX programs w/r/t `EINTR`), the user has two basic options.  They can either</span></div>
<div class="line"><a id="l00222" name="l00222"></a><span class="lineno">  222</span><span class="comment"> * register signal handlers that&#39;ll explicitly invoke that method; or they can let Node do so</span></div>
<div class="line"><a id="l00223" name="l00223"></a><span class="lineno">  223</span><span class="comment"> * automatically for SIGINT and SIGTERM.  This is controlled by the Node option</span></div>
<div class="line"><a id="l00224" name="l00224"></a><span class="lineno">  224</span><span class="comment"> * Node_options::m_st_capture_interrupt_signals_internally.</span></div>
<div class="line"><a id="l00225" name="l00225"></a><span class="lineno">  225</span><span class="comment"> *</span></div>
<div class="line"><a id="l00226" name="l00226"></a><span class="lineno">  226</span><span class="comment"> * ### Thread safety ###</span></div>
<div class="line"><a id="l00227" name="l00227"></a><span class="lineno">  227</span><span class="comment"> * Same as for Peer_socket.  (Briefly: all operations safe for simultaneous execution</span></div>
<div class="line"><a id="l00228" name="l00228"></a><span class="lineno">  228</span><span class="comment"> * on separate or the same object.)  An informal recommendation, however, is to only use a given</span></div>
<div class="line"><a id="l00229" name="l00229"></a><span class="lineno">  229</span><span class="comment"> * Event_set in one thread.  Otherwise things will get confusing, quickly, with no practical benefit of which</span></div>
<div class="line"><a id="l00230" name="l00230"></a><span class="lineno">  230</span><span class="comment"> * I, at least, am aware.</span></div>
<div class="line"><a id="l00231" name="l00231"></a><span class="lineno">  231</span><span class="comment"> *</span></div>
<div class="line"><a id="l00232" name="l00232"></a><span class="lineno">  232</span><span class="comment"> * @internal</span></div>
<div class="line"><a id="l00233" name="l00233"></a><span class="lineno">  233</span><span class="comment"> *</span></div>
<div class="line"><a id="l00234" name="l00234"></a><span class="lineno">  234</span><span class="comment"> * ### Implementation notes ###</span></div>
<div class="line"><a id="l00235" name="l00235"></a><span class="lineno">  235</span><span class="comment"> * The crux of the implementation is in async_wait(), as all other wait types are built on it.</span></div>
<div class="line"><a id="l00236" name="l00236"></a><span class="lineno">  236</span><span class="comment"> * Therefore there is a giant comment inside that method that is required reading for understanding</span></div>
<div class="line"><a id="l00237" name="l00237"></a><span class="lineno">  237</span><span class="comment"> * this class&#39;s innards (which, IMO, are some of the trickiest logic in all of the library).</span></div>
<div class="line"><a id="l00238" name="l00238"></a><span class="lineno">  238</span><span class="comment"> *</span></div>
<div class="line"><a id="l00239" name="l00239"></a><span class="lineno">  239</span><span class="comment"> * As with Peer_socket and Server_socket, much of the implementation (as opposed to interface) of</span></div>
<div class="line"><a id="l00240" name="l00240"></a><span class="lineno">  240</span><span class="comment"> * Event_set functionality resides in class Node.  In particular anything to do with thread W is in</span></div>
<div class="line"><a id="l00241" name="l00241"></a><span class="lineno">  241</span><span class="comment"> * Node.  The actual code is in event_set.cpp, but since the logic involves Node state, and</span></div>
<div class="line"><a id="l00242" name="l00242"></a><span class="lineno">  242</span><span class="comment"> * Event_set is subservient to the Node, in terms of objects it makes more sense to keep it in</span></div>
<div class="line"><a id="l00243" name="l00243"></a><span class="lineno">  243</span><span class="comment"> * class Node.  However, when no Node state is involved, Event_set logic is actually typically</span></div>
<div class="line"><a id="l00244" name="l00244"></a><span class="lineno">  244</span><span class="comment"> * coded in Event_set methods, to a greater extent than in Peer_socket or Server_socket, which are</span></div>
<div class="line"><a id="l00245" name="l00245"></a><span class="lineno">  245</span><span class="comment"> * mere data stores in comparison.</span></div>
<div class="line"><a id="l00246" name="l00246"></a><span class="lineno">  246</span><span class="comment"> */</span></div>
<div class="line"><a id="l00247" name="l00247"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Event__set.html">  247</a></span><span class="keyword">class </span><a class="code hl_class" href="classflow_1_1net__flow_1_1Event__set.html">Event_set</a> :</div>
<div class="line"><a id="l00248" name="l00248"></a><span class="lineno">  248</span>  <span class="comment">// Endow us with shared_ptr&lt;&gt;s ::Ptr and ::Const_ptr (syntactic sugar).</span></div>
<div class="line"><a id="l00249" name="l00249"></a><span class="lineno">  249</span>  <span class="keyword">public</span> <a class="code hl_class" href="classflow_1_1util_1_1Shared__ptr__alias__holder.html">util::Shared_ptr_alias_holder</a>&lt;boost::shared_ptr&lt;Event_set&gt;&gt;,</div>
<div class="line"><a id="l00250" name="l00250"></a><span class="lineno">  250</span>  <span class="comment">// Allow access to Ptr(this) from inside Event_set methods.  Just call shared_from_this().</span></div>
<div class="line"><a id="l00251" name="l00251"></a><span class="lineno">  251</span>  <span class="keyword">public</span> boost::enable_shared_from_this&lt;Event_set&gt;,</div>
<div class="line"><a id="l00252" name="l00252"></a><span class="lineno">  252</span>  <span class="keyword">public</span> <a class="code hl_class" href="classflow_1_1log_1_1Log__context.html">log::Log_context</a>,</div>
<div class="line"><a id="l00253" name="l00253"></a><span class="lineno">  253</span>  <span class="keyword">private</span> boost::noncopyable</div>
<div class="line"><a id="l00254" name="l00254"></a><span class="lineno">  254</span>{</div>
<div class="line"><a id="l00255" name="l00255"></a><span class="lineno">  255</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00256" name="l00256"></a><span class="lineno">  256</span>  <span class="comment">// Types.</span></div>
<div class="line"><a id="l00257" name="l00257"></a><span class="lineno">  257</span><span class="comment"></span> </div>
<div class="line"><a id="l00258" name="l00258"></a><span class="lineno">  258</span><span class="comment">  /// A state of an Event_set.</span></div>
<div class="line"><a id="l00259" name="l00259"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Event__set.html#a2855bd159b6e63bf448ed1f41b608975">  259</a></span><span class="comment"></span>  <span class="keyword">enum class</span> <a class="code hl_enumeration" href="classflow_1_1net__flow_1_1Event__set.html#a2855bd159b6e63bf448ed1f41b608975">State</a></div>
<div class="line"><a id="l00260" name="l00260"></a><span class="lineno">  260</span>  {<span class="comment"></span></div>
<div class="line"><a id="l00261" name="l00261"></a><span class="lineno">  261</span><span class="comment">    /**</span></div>
<div class="line"><a id="l00262" name="l00262"></a><span class="lineno">  262</span><span class="comment">     * Default state; valid Event_set that is not currently waiting on events.  All user</span></div>
<div class="line"><a id="l00263" name="l00263"></a><span class="lineno">  263</span><span class="comment">     * operations are valid in this state.</span></div>
<div class="line"><a id="l00264" name="l00264"></a><span class="lineno">  264</span><span class="comment">     */</span></div>
<div class="line"><a id="l00265" name="l00265"></a><span class="lineno">  265</span>    S_INACTIVE,<span class="comment"></span></div>
<div class="line"><a id="l00266" name="l00266"></a><span class="lineno">  266</span><span class="comment">    /**</span></div>
<div class="line"><a id="l00267" name="l00267"></a><span class="lineno">  267</span><span class="comment">     * Waiting state: valid Event_set that is currently waiting on previously described events. In</span></div>
<div class="line"><a id="l00268" name="l00268"></a><span class="lineno">  268</span><span class="comment">     * this state only async_wait_finish() may be called without resulting in an error.</span></div>
<div class="line"><a id="l00269" name="l00269"></a><span class="lineno">  269</span><span class="comment">     */</span></div>
<div class="line"><a id="l00270" name="l00270"></a><span class="lineno">  270</span>    S_WAITING,<span class="comment"></span></div>
<div class="line"><a id="l00271" name="l00271"></a><span class="lineno">  271</span><span class="comment">    /// Node has disowned the Peer_socket; all further operations will result in error.</span></div>
<div class="line"><a id="l00272" name="l00272"></a><span class="lineno">  272</span><span class="comment"></span>    S_CLOSED</div>
<div class="line"><a id="l00273" name="l00273"></a><span class="lineno">  273</span>  }; <span class="comment">// enum class State</span></div>
<div class="line"><a id="l00274" name="l00274"></a><span class="lineno">  274</span><span class="comment"></span> </div>
<div class="line"><a id="l00275" name="l00275"></a><span class="lineno">  275</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00276" name="l00276"></a><span class="lineno">  276</span><span class="comment">   * Type of event or condition of interest supported by class Event_set.  When specifying interest in some socket</span></div>
<div class="line"><a id="l00277" name="l00277"></a><span class="lineno">  277</span><span class="comment">   * reaching a certain condition, or when requesting the results of that interest, the user essentially specifies</span></div>
<div class="line"><a id="l00278" name="l00278"></a><span class="lineno">  278</span><span class="comment">   * a pair of data: an enumeration value of this type and a socket of a certain type (that type is specified in</span></div>
<div class="line"><a id="l00279" name="l00279"></a><span class="lineno">  279</span><span class="comment">   * the very name of the #Event_type).  For example, I may be interested in Event_type::S_PEER_SOCKET_READABLE</span></div>
<div class="line"><a id="l00280" name="l00280"></a><span class="lineno">  280</span><span class="comment">   * becoming true for Peer_socket::Ptr `sock`.  The precise meaning is documented for each enumeration value.</span></div>
<div class="line"><a id="l00281" name="l00281"></a><span class="lineno">  281</span><span class="comment">   *</span></div>
<div class="line"><a id="l00282" name="l00282"></a><span class="lineno">  282</span><span class="comment">   * @internal</span></div>
<div class="line"><a id="l00283" name="l00283"></a><span class="lineno">  283</span><span class="comment">   *</span></div>
<div class="line"><a id="l00284" name="l00284"></a><span class="lineno">  284</span><span class="comment">   * ### Implementation notes ###</span></div>
<div class="line"><a id="l00285" name="l00285"></a><span class="lineno">  285</span><span class="comment">   * You will note a few different structures, such as Event_set::m_want and Event_set::m_can, are keyed by this</span></div>
<div class="line"><a id="l00286" name="l00286"></a><span class="lineno">  286</span><span class="comment">   * type.  Doing it that way, instead of simply having a simpler Event_set::m_want-like structure (etc.) exist 3x,</span></div>
<div class="line"><a id="l00287" name="l00287"></a><span class="lineno">  287</span><span class="comment">   * has its plusses and minuses.  Historically, this was actually implemented that other way first, but I wanted</span></div>
<div class="line"><a id="l00288" name="l00288"></a><span class="lineno">  288</span><span class="comment">   * to play with `boost::any` to see if it makes the code more elegant.  It has certainly resulted in significantly</span></div>
<div class="line"><a id="l00289" name="l00289"></a><span class="lineno">  289</span><span class="comment">   * fewer methods and less code; and in code that is more generic (and, in principle, extensible if we somehow</span></div>
<div class="line"><a id="l00290" name="l00290"></a><span class="lineno">  290</span><span class="comment">   * come up with another event type of interest); and less bug-prone.  The code is also arguably more opaque and</span></div>
<div class="line"><a id="l00291" name="l00291"></a><span class="lineno">  291</span><span class="comment">   * harder to grok right off the bat, as it&#39;s more abstract.  Finally, from the user&#39;s point of view, it is slightly</span></div>
<div class="line"><a id="l00292" name="l00292"></a><span class="lineno">  292</span><span class="comment">   * harder to use in that when emitting results of an `Event_set::[a]sync_wait()`,</span></div>
<div class="line"><a id="l00293" name="l00293"></a><span class="lineno">  293</span><span class="comment">   * one must `any_cast&lt;&gt;` to the proper socket type -- easy but requires a small learning curve.  I&#39;ll</span></div>
<div class="line"><a id="l00294" name="l00294"></a><span class="lineno">  294</span><span class="comment">   * say overall it is better this way than the other way.</span></div>
<div class="line"><a id="l00295" name="l00295"></a><span class="lineno">  295</span><span class="comment">   *</span></div>
<div class="line"><a id="l00296" name="l00296"></a><span class="lineno">  296</span><span class="comment">   * In terms of extending this `enum`, which seems unlikely, the following would be involved.  Add a value for</span></div>
<div class="line"><a id="l00297" name="l00297"></a><span class="lineno">  297</span><span class="comment">   * the `enum`; then add clauses for it in Socket_as_any_hash::operator(), Socket_as_any_equals::operator(),</span></div>
<div class="line"><a id="l00298" name="l00298"></a><span class="lineno">  298</span><span class="comment">   * Event_set::sock_as_any_to_str().  Extend the structures in Event_set::empty_ev_type_to_socks_map() and</span></div>
<div class="line"><a id="l00299" name="l00299"></a><span class="lineno">  299</span><span class="comment">   * S_EV_TYPE_TO_IS_ACTIVE_NODE_MTD.  The latter will need a new method written in Node that checks for</span></div>
<div class="line"><a id="l00300" name="l00300"></a><span class="lineno">  300</span><span class="comment">   * whether the condition of this type currently holds for the given socket -- whose type, by the way, you will</span></div>
<div class="line"><a id="l00301" name="l00301"></a><span class="lineno">  301</span><span class="comment">   * need to decide and document in the doc header for the new `enum` value.  Finally, you&#39;ll need to find all</span></div>
<div class="line"><a id="l00302" name="l00302"></a><span class="lineno">  302</span><span class="comment">   * situations throughout the code where the condition may change from not holding to holding and possibly</span></div>
<div class="line"><a id="l00303" name="l00303"></a><span class="lineno">  303</span><span class="comment">   * save it into Node::m_sock_events when detected (for example, see when `m_sock_events[S_PEER_SOCKET_READABLE]`</span></div>
<div class="line"><a id="l00304" name="l00304"></a><span class="lineno">  304</span><span class="comment">   * is `insert()`ed into).</span></div>
<div class="line"><a id="l00305" name="l00305"></a><span class="lineno">  305</span><span class="comment">   */</span></div>
<div class="line"><a id="l00306" name="l00306"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Event__set.html#a19cc3a286c8a11c986d2a59ec1e39a71">  306</a></span>  <span class="keyword">enum class</span> <a class="code hl_enumeration" href="classflow_1_1net__flow_1_1Event__set.html#a19cc3a286c8a11c986d2a59ec1e39a71">Event_type</a></div>
<div class="line"><a id="l00307" name="l00307"></a><span class="lineno">  307</span>  {<span class="comment"></span></div>
<div class="line"><a id="l00308" name="l00308"></a><span class="lineno">  308</span><span class="comment">    /**</span></div>
<div class="line"><a id="l00309" name="l00309"></a><span class="lineno">  309</span><span class="comment">     * Event type specifying the condition of interest wherein a target `Peer_socket sock` is such that</span></div>
<div class="line"><a id="l00310" name="l00310"></a><span class="lineno">  310</span><span class="comment">     * calling `sock-&gt;receive()` would yield either non-zero (&quot;successfully dequeued</span></div>
<div class="line"><a id="l00311" name="l00311"></a><span class="lineno">  311</span><span class="comment">     * received data&quot;) or zero and an error (but not zero and NO error).  In other words, specifies</span></div>
<div class="line"><a id="l00312" name="l00312"></a><span class="lineno">  312</span><span class="comment">     * the condition where a Peer_socket is Readable.</span></div>
<div class="line"><a id="l00313" name="l00313"></a><span class="lineno">  313</span><span class="comment">     *</span></div>
<div class="line"><a id="l00314" name="l00314"></a><span class="lineno">  314</span><span class="comment">     * In Event_set::Sockets structures associated with this Event_set::Event_type, `boost::any` elements</span></div>
<div class="line"><a id="l00315" name="l00315"></a><span class="lineno">  315</span><span class="comment">     * wrap the type: Peer_socket::Ptr. `boost::any_cast&lt;&gt;` to that type to obtain the socket.</span></div>
<div class="line"><a id="l00316" name="l00316"></a><span class="lineno">  316</span><span class="comment">     */</span></div>
<div class="line"><a id="l00317" name="l00317"></a><span class="lineno">  317</span>    S_PEER_SOCKET_READABLE,</div>
<div class="line"><a id="l00318" name="l00318"></a><span class="lineno">  318</span><span class="comment"></span> </div>
<div class="line"><a id="l00319" name="l00319"></a><span class="lineno">  319</span><span class="comment">    /**</span></div>
<div class="line"><a id="l00320" name="l00320"></a><span class="lineno">  320</span><span class="comment">     * Event type specifying the condition of interest wherein a target `Peer_socket sock` is such that</span></div>
<div class="line"><a id="l00321" name="l00321"></a><span class="lineno">  321</span><span class="comment">     * calling `sock-&gt;send()` with a non-empty buffer would yield either non-zero (&quot;successfully enqueued</span></div>
<div class="line"><a id="l00322" name="l00322"></a><span class="lineno">  322</span><span class="comment">     * data to be sent&quot;) or zero and an error (but not zero and NO error).  In other words, specifies</span></div>
<div class="line"><a id="l00323" name="l00323"></a><span class="lineno">  323</span><span class="comment">     * the condition where a Peer_socket is Writable.</span></div>
<div class="line"><a id="l00324" name="l00324"></a><span class="lineno">  324</span><span class="comment">     *</span></div>
<div class="line"><a id="l00325" name="l00325"></a><span class="lineno">  325</span><span class="comment">     * In Event_set::Sockets structures associated with this Event_set::Event_type, `boost::any` elements</span></div>
<div class="line"><a id="l00326" name="l00326"></a><span class="lineno">  326</span><span class="comment">     * wrap the type: Peer_socket::Ptr. `boost::any_cast&lt;&gt;` to that type to obtain the socket.</span></div>
<div class="line"><a id="l00327" name="l00327"></a><span class="lineno">  327</span><span class="comment">     */</span></div>
<div class="line"><a id="l00328" name="l00328"></a><span class="lineno">  328</span>    S_PEER_SOCKET_WRITABLE,</div>
<div class="line"><a id="l00329" name="l00329"></a><span class="lineno">  329</span><span class="comment"></span> </div>
<div class="line"><a id="l00330" name="l00330"></a><span class="lineno">  330</span><span class="comment">    /**</span></div>
<div class="line"><a id="l00331" name="l00331"></a><span class="lineno">  331</span><span class="comment">     * Event type specifying the condition of interest wherein a target `Server_socket serv` is such that</span></div>
<div class="line"><a id="l00332" name="l00332"></a><span class="lineno">  332</span><span class="comment">     * calling `serv-&gt;accept()` would yield either non-null (&quot;successfully accepted a ready conneection&quot;)</span></div>
<div class="line"><a id="l00333" name="l00333"></a><span class="lineno">  333</span><span class="comment">     * or null and an error (but not null and NO error).  In other words, specifies</span></div>
<div class="line"><a id="l00334" name="l00334"></a><span class="lineno">  334</span><span class="comment">     * the condition where a Server_socket is Acceptable.</span></div>
<div class="line"><a id="l00335" name="l00335"></a><span class="lineno">  335</span><span class="comment">     *</span></div>
<div class="line"><a id="l00336" name="l00336"></a><span class="lineno">  336</span><span class="comment">     * In Event_set::Sockets structures associated with this Event_set::Event_type, `boost::any` elements</span></div>
<div class="line"><a id="l00337" name="l00337"></a><span class="lineno">  337</span><span class="comment">     * wrap the type: Server_socket::Ptr. `boost::any_cast&lt;&gt;` to that type to obtain the socket.</span></div>
<div class="line"><a id="l00338" name="l00338"></a><span class="lineno">  338</span><span class="comment">     */</span></div>
<div class="line"><a id="l00339" name="l00339"></a><span class="lineno">  339</span>    S_SERVER_SOCKET_ACCEPTABLE</div>
<div class="line"><a id="l00340" name="l00340"></a><span class="lineno">  340</span>  }; <span class="comment">// enum class Event_type</span></div>
<div class="line"><a id="l00341" name="l00341"></a><span class="lineno">  341</span> </div>
<div class="line"><a id="l00342" name="l00342"></a><span class="lineno">  342</span>  <span class="keyword">class </span>Socket_as_any_hash;</div>
<div class="line"><a id="l00343" name="l00343"></a><span class="lineno">  343</span>  <span class="keyword">class </span>Socket_as_any_equals;</div>
<div class="line"><a id="l00344" name="l00344"></a><span class="lineno">  344</span><span class="comment"></span> </div>
<div class="line"><a id="l00345" name="l00345"></a><span class="lineno">  345</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00346" name="l00346"></a><span class="lineno">  346</span><span class="comment">   * A set of sockets of one type, used to communicate sets of desired and resulting events in various Event_set</span></div>
<div class="line"><a id="l00347" name="l00347"></a><span class="lineno">  347</span><span class="comment">   * APIs.  As a rule, a given #Sockets object will store sockets of one underlying type; meaning</span></div>
<div class="line"><a id="l00348" name="l00348"></a><span class="lineno">  348</span><span class="comment">   * the `boost::any`s stored inside one such set can ALL be `boost::any_cast&lt;&gt;` to the *same* type.  Which type that</span></div>
<div class="line"><a id="l00349" name="l00349"></a><span class="lineno">  349</span><span class="comment">   * is is usually determined by the associated #Event_type value, typically supplied alongside a #Sockets set</span></div>
<div class="line"><a id="l00350" name="l00350"></a><span class="lineno">  350</span><span class="comment">   * in another argument.  For example, if `ev_type == Event_type::S_PEER_SOCKET_READABLE`, then every `boost::any`</span></div>
<div class="line"><a id="l00351" name="l00351"></a><span class="lineno">  351</span><span class="comment">   * in the set can be decoded as follows: `Peer_socket::Ptr sock = any_cast&lt;Peer_socket::Ptr&gt;(sock_as_any)`, where</span></div>
<div class="line"><a id="l00352" name="l00352"></a><span class="lineno">  352</span><span class="comment">   * `sock_as_any` is an element in a #Sockets.</span></div>
<div class="line"><a id="l00353" name="l00353"></a><span class="lineno">  353</span><span class="comment">   *</span></div>
<div class="line"><a id="l00354" name="l00354"></a><span class="lineno">  354</span><span class="comment">   * As of this writing, the type is chronologically ordered; meaning sockets will be stored in order from latest to</span></div>
<div class="line"><a id="l00355" name="l00355"></a><span class="lineno">  355</span><span class="comment">   * oldest to be inserted into the structure.  E.g., emit_result_sockets() will produce a set containing of</span></div>
<div class="line"><a id="l00356" name="l00356"></a><span class="lineno">  356</span><span class="comment">   * readable sockets, in reverse chronological order in which they were detected as being readable.  This may or may</span></div>
<div class="line"><a id="l00357" name="l00357"></a><span class="lineno">  357</span><span class="comment">   * not be useful in debugging.</span></div>
<div class="line"><a id="l00358" name="l00358"></a><span class="lineno">  358</span><span class="comment">   *</span></div>
<div class="line"><a id="l00359" name="l00359"></a><span class="lineno">  359</span><span class="comment">   * @internal</span></div>
<div class="line"><a id="l00360" name="l00360"></a><span class="lineno">  360</span><span class="comment">   *</span></div>
<div class="line"><a id="l00361" name="l00361"></a><span class="lineno">  361</span><span class="comment">   * This type is also used internally extensively.</span></div>
<div class="line"><a id="l00362" name="l00362"></a><span class="lineno">  362</span><span class="comment">   *</span></div>
<div class="line"><a id="l00363" name="l00363"></a><span class="lineno">  363</span><span class="comment">   * @todo Is it necessary to have Event_set::Sockets be aliased to util::Linked_hash_set?  `unordered_set` would also</span></div>
<div class="line"><a id="l00364" name="l00364"></a><span class="lineno">  364</span><span class="comment">   * work and take somewhat less memory and computational overhead.  It would become unordered, instead of ordered</span></div>
<div class="line"><a id="l00365" name="l00365"></a><span class="lineno">  365</span><span class="comment">   * chronologically, but that seems like a price possibly worth paying.</span></div>
<div class="line"><a id="l00366" name="l00366"></a><span class="lineno">  366</span><span class="comment">   *</span></div>
<div class="line"><a id="l00367" name="l00367"></a><span class="lineno">  367</span><span class="comment">   * Note, also, the to-do in emit_result_sockets() doc header, regarding using `variant` instead of `any`.</span></div>
<div class="line"><a id="l00368" name="l00368"></a><span class="lineno">  368</span><span class="comment">   * Not only would that be faster and arguably safer, being compile-time in nature; but we&#39;d get</span></div>
<div class="line"><a id="l00369" name="l00369"></a><span class="lineno">  369</span><span class="comment">   * hashing/equality for free -- hence the code would be much pithier (no need for Socket_as_any_hash or</span></div>
<div class="line"><a id="l00370" name="l00370"></a><span class="lineno">  370</span><span class="comment">   * Socket_as_any_equals).</span></div>
<div class="line"><a id="l00371" name="l00371"></a><span class="lineno">  371</span><span class="comment">   */</span></div>
<div class="line"><a id="l00372" name="l00372"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Event__set.html#a592b3ce6602051bd9994216041a3cbdc">  372</a></span>  <span class="keyword">using </span><a class="code hl_class" href="classflow_1_1util_1_1Linked__hash__set.html">Sockets</a> = <a class="code hl_class" href="classflow_1_1util_1_1Linked__hash__set.html">util::Linked_hash_set&lt;boost::any, Socket_as_any_hash, Socket_as_any_equals&gt;</a>;</div>
<div class="line"><a id="l00373" name="l00373"></a><span class="lineno">  373</span><span class="comment"></span> </div>
<div class="line"><a id="l00374" name="l00374"></a><span class="lineno">  374</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00375" name="l00375"></a><span class="lineno">  375</span><span class="comment">   * The type for custom handler passed to async_wait(), which is executed when one or more active events detected, or</span></div>
<div class="line"><a id="l00376" name="l00376"></a><span class="lineno">  376</span><span class="comment">   * interrupted as if by signal.</span></div>
<div class="line"><a id="l00377" name="l00377"></a><span class="lineno">  377</span><span class="comment">   *</span></div>
<div class="line"><a id="l00378" name="l00378"></a><span class="lineno">  378</span><span class="comment">   * @internal</span></div>
<div class="line"><a id="l00379" name="l00379"></a><span class="lineno">  379</span><span class="comment">   *</span></div>
<div class="line"><a id="l00380" name="l00380"></a><span class="lineno">  380</span><span class="comment">   * @todo Perhaps async_wait() and other APIs of Event_set taking handlers should be templated on handler type</span></div>
<div class="line"><a id="l00381" name="l00381"></a><span class="lineno">  381</span><span class="comment">   * for syntactic sugar.  Though, currently, this would be no faster (it is internally stored as this type anyway and</span></div>
<div class="line"><a id="l00382" name="l00382"></a><span class="lineno">  382</span><span class="comment">   * must be so), nor would it actually improve call code which needs no explicit cast (an object of this type will</span></div>
<div class="line"><a id="l00383" name="l00383"></a><span class="lineno">  383</span><span class="comment">   * implicitly be substituted as a conversion from whatever compatible-with-this-signature construction they used).</span></div>
<div class="line"><a id="l00384" name="l00384"></a><span class="lineno">  384</span><span class="comment">   * So on balance, this currently appears superior.  After all writing non-template bodies is easier/nicer.</span></div>
<div class="line"><a id="l00385" name="l00385"></a><span class="lineno">  385</span><span class="comment">   */</span></div>
<div class="line"><a id="l00386" name="l00386"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Event__set.html#a9da325d6cb993b975eec99adaafd3dce">  386</a></span>  <span class="keyword">using </span><a class="code hl_class" href="classflow_1_1Function.html">Event_handler</a> = <a class="code hl_class" href="classflow_1_1Function.html">Function</a>&lt;void (<span class="keywordtype">bool</span>)&gt;;</div>
<div class="line"><a id="l00387" name="l00387"></a><span class="lineno">  387</span> </div>
<div class="line"><a id="l00388" name="l00388"></a><span class="lineno">  388</span>  <span class="comment">// Constructors/destructor.</span></div>
<div class="line"><a id="l00389" name="l00389"></a><span class="lineno">  389</span><span class="comment"></span> </div>
<div class="line"><a id="l00390" name="l00390"></a><span class="lineno">  390</span><span class="comment">  /// Boring destructor.  Note that deletion is to be handled exclusively via `shared_ptr`, never explicitly.</span></div>
<div class="line"><a id="l00391" name="l00391"></a><span class="lineno">  391</span><span class="comment"></span>  <a class="code hl_function" href="classflow_1_1net__flow_1_1Event__set.html#accb662e50999e2d0800f59a7a131bffa">~Event_set</a>();</div>
<div class="line"><a id="l00392" name="l00392"></a><span class="lineno">  392</span> </div>
<div class="line"><a id="l00393" name="l00393"></a><span class="lineno">  393</span>  <span class="comment">// Methods.</span></div>
<div class="line"><a id="l00394" name="l00394"></a><span class="lineno">  394</span><span class="comment"></span> </div>
<div class="line"><a id="l00395" name="l00395"></a><span class="lineno">  395</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00396" name="l00396"></a><span class="lineno">  396</span><span class="comment">   * Current State of the Event_set.  Note that this may change the moment the method returns.</span></div>
<div class="line"><a id="l00397" name="l00397"></a><span class="lineno">  397</span><span class="comment">   *</span></div>
<div class="line"><a id="l00398" name="l00398"></a><span class="lineno">  398</span><span class="comment">   * @return Ditto.</span></div>
<div class="line"><a id="l00399" name="l00399"></a><span class="lineno">  399</span><span class="comment">   */</span></div>
<div class="line"><a id="l00400" name="l00400"></a><span class="lineno">  400</span>  <a class="code hl_enumeration" href="classflow_1_1net__flow_1_1Event__set.html#a2855bd159b6e63bf448ed1f41b608975">State</a> <a class="code hl_function" href="classflow_1_1net__flow_1_1Event__set.html#a8453cccdaaf22ea6b027c5de9738f0f0">state</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00401" name="l00401"></a><span class="lineno">  401</span><span class="comment"></span> </div>
<div class="line"><a id="l00402" name="l00402"></a><span class="lineno">  402</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00403" name="l00403"></a><span class="lineno">  403</span><span class="comment">   * Node that produced this Event_set.  Note that this may change the moment the method returns</span></div>
<div class="line"><a id="l00404" name="l00404"></a><span class="lineno">  404</span><span class="comment">   * (but only to null).</span></div>
<div class="line"><a id="l00405" name="l00405"></a><span class="lineno">  405</span><span class="comment">   *</span></div>
<div class="line"><a id="l00406" name="l00406"></a><span class="lineno">  406</span><span class="comment">   * @return Pointer to (guaranteed valid) Node; null if state() is S_CLOSED.</span></div>
<div class="line"><a id="l00407" name="l00407"></a><span class="lineno">  407</span><span class="comment">   */</span></div>
<div class="line"><a id="l00408" name="l00408"></a><span class="lineno">  408</span>  <a class="code hl_class" href="classflow_1_1net__flow_1_1Node.html">Node</a>* <a class="code hl_function" href="classflow_1_1net__flow_1_1Event__set.html#aafa4275ad4f93ae274f7f88fd257ce33">node</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00409" name="l00409"></a><span class="lineno">  409</span><span class="comment"></span> </div>
<div class="line"><a id="l00410" name="l00410"></a><span class="lineno">  410</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00411" name="l00411"></a><span class="lineno">  411</span><span class="comment">   * Clears all stored resources (any desired events, result events, and any handler saved by</span></div>
<div class="line"><a id="l00412" name="l00412"></a><span class="lineno">  412</span><span class="comment">   * async_wait()) and moves state to State::S_CLOSED.  In particular Node will have disowned this object</span></div>
<div class="line"><a id="l00413" name="l00413"></a><span class="lineno">  413</span><span class="comment">   * by the time close() returns.</span></div>
<div class="line"><a id="l00414" name="l00414"></a><span class="lineno">  414</span><span class="comment">   *</span></div>
<div class="line"><a id="l00415" name="l00415"></a><span class="lineno">  415</span><span class="comment">   * You might call close() while state is State::S_WAITING, but if a timeout-less sync_wait() is executing</span></div>
<div class="line"><a id="l00416" name="l00416"></a><span class="lineno">  416</span><span class="comment">   * in another thread, it will NEVER return.  Similarly, if state is currently WAITING due to</span></div>
<div class="line"><a id="l00417" name="l00417"></a><span class="lineno">  417</span><span class="comment">   * async_wait(), the handler saved by async_wait() will NEVER be called.  So don&#39;t do that.</span></div>
<div class="line"><a id="l00418" name="l00418"></a><span class="lineno">  418</span><span class="comment">   * However, first closing one or more sockets being waited on by those calls and THEN calling</span></div>
<div class="line"><a id="l00419" name="l00419"></a><span class="lineno">  419</span><span class="comment">   * `this-&gt;close()` is perfectly safe, in that sync_wait() will exit, or the handler will be called.</span></div>
<div class="line"><a id="l00420" name="l00420"></a><span class="lineno">  420</span><span class="comment">   * (In fact when Node shuts down it does just that.)</span></div>
<div class="line"><a id="l00421" name="l00421"></a><span class="lineno">  421</span><span class="comment">   *</span></div>
<div class="line"><a id="l00422" name="l00422"></a><span class="lineno">  422</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00423" name="l00423"></a><span class="lineno">  423</span><span class="comment">   *        See flow::Error_code docs for error reporting semantics.  Generated codes:</span></div>
<div class="line"><a id="l00424" name="l00424"></a><span class="lineno">  424</span><span class="comment">   *        error::Code::S_EVENT_SET_CLOSED.</span></div>
<div class="line"><a id="l00425" name="l00425"></a><span class="lineno">  425</span><span class="comment">   */</span></div>
<div class="line"><a id="l00426" name="l00426"></a><span class="lineno">  426</span>  <span class="keywordtype">void</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Event__set.html#a9ae292072a84d07c867536e3de3b878e">close</a>(<a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00427" name="l00427"></a><span class="lineno">  427</span><span class="comment"></span> </div>
<div class="line"><a id="l00428" name="l00428"></a><span class="lineno">  428</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00429" name="l00429"></a><span class="lineno">  429</span><span class="comment">   * Adds the given socket to the set of sockets we want to know are &quot;ready&quot; by the definition of</span></div>
<div class="line"><a id="l00430" name="l00430"></a><span class="lineno">  430</span><span class="comment">   * the given event type.  See individual Event_type enumeration members&#39; doc comments for exact</span></div>
<div class="line"><a id="l00431" name="l00431"></a><span class="lineno">  431</span><span class="comment">   * definition of readiness for each #Event_type.  For example, Event_type::S_PEER_SOCKET_READABLE</span></div>
<div class="line"><a id="l00432" name="l00432"></a><span class="lineno">  432</span><span class="comment">   * means we want to know when `sock-&gt;receive()` would yield either some data or an error, but not</span></div>
<div class="line"><a id="l00433" name="l00433"></a><span class="lineno">  433</span><span class="comment">   * no data and no error.</span></div>
<div class="line"><a id="l00434" name="l00434"></a><span class="lineno">  434</span><span class="comment">   *</span></div>
<div class="line"><a id="l00435" name="l00435"></a><span class="lineno">  435</span><span class="comment">   * @tparam Socket type to which `ev_type` applies.  E.g., Peer_socket for PEER_SOCKET_READABLE.</span></div>
<div class="line"><a id="l00436" name="l00436"></a><span class="lineno">  436</span><span class="comment">   * @param sock</span></div>
<div class="line"><a id="l00437" name="l00437"></a><span class="lineno">  437</span><span class="comment">   *        Socket to add.  Must be from the same Node as the one originating this Event_set.</span></div>
<div class="line"><a id="l00438" name="l00438"></a><span class="lineno">  438</span><span class="comment">   * @param ev_type</span></div>
<div class="line"><a id="l00439" name="l00439"></a><span class="lineno">  439</span><span class="comment">   *        The condition we are interested in `sock` reaching.</span></div>
<div class="line"><a id="l00440" name="l00440"></a><span class="lineno">  440</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00441" name="l00441"></a><span class="lineno">  441</span><span class="comment">   *        See flow::Error_code docs for error reporting semantics.  Generated codes:</span></div>
<div class="line"><a id="l00442" name="l00442"></a><span class="lineno">  442</span><span class="comment">   *        error::Code::S_EVENT_SET_ALREADY_EXISTS, error::Code::S_EVENT_SET_CLOSED,</span></div>
<div class="line"><a id="l00443" name="l00443"></a><span class="lineno">  443</span><span class="comment">   *        error::Code::S_EVENT_SET_IMMUTABLE_WHEN_WAITING.</span></div>
<div class="line"><a id="l00444" name="l00444"></a><span class="lineno">  444</span><span class="comment">   * @return `true` if and only if no error occurred (`*err_code` is success).</span></div>
<div class="line"><a id="l00445" name="l00445"></a><span class="lineno">  445</span><span class="comment">   */</span></div>
<div class="line"><a id="l00446" name="l00446"></a><span class="lineno">  446</span>  <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Socket&gt;</div>
<div class="line"><a id="l00447" name="l00447"></a><span class="lineno">  447</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Event__set.html#a496b760adb19356b4aee9a17ca13b523">add_wanted_socket</a>(<span class="keyword">typename</span> Socket::Ptr sock, <a class="code hl_enumeration" href="classflow_1_1net__flow_1_1Event__set.html#a19cc3a286c8a11c986d2a59ec1e39a71">Event_type</a> ev_type, <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00448" name="l00448"></a><span class="lineno">  448</span><span class="comment"></span> </div>
<div class="line"><a id="l00449" name="l00449"></a><span class="lineno">  449</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00450" name="l00450"></a><span class="lineno">  450</span><span class="comment">   * Opposite of add_wanted_socket().</span></div>
<div class="line"><a id="l00451" name="l00451"></a><span class="lineno">  451</span><span class="comment">   *</span></div>
<div class="line"><a id="l00452" name="l00452"></a><span class="lineno">  452</span><span class="comment">   * @tparam See add_wanted_socket().</span></div>
<div class="line"><a id="l00453" name="l00453"></a><span class="lineno">  453</span><span class="comment">   * @param sock</span></div>
<div class="line"><a id="l00454" name="l00454"></a><span class="lineno">  454</span><span class="comment">   *        Socket to remove.</span></div>
<div class="line"><a id="l00455" name="l00455"></a><span class="lineno">  455</span><span class="comment">   * @param ev_type</span></div>
<div class="line"><a id="l00456" name="l00456"></a><span class="lineno">  456</span><span class="comment">   *        See add_wanted_socket().</span></div>
<div class="line"><a id="l00457" name="l00457"></a><span class="lineno">  457</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00458" name="l00458"></a><span class="lineno">  458</span><span class="comment">   *        See flow::Error_code docs for error reporting semantics.  Generated codes:</span></div>
<div class="line"><a id="l00459" name="l00459"></a><span class="lineno">  459</span><span class="comment">   *        error::Code::S_EVENT_SET_EVENT_DOES_NOT_EXIST, error::Code::S_EVENT_SET_CLOSED,</span></div>
<div class="line"><a id="l00460" name="l00460"></a><span class="lineno">  460</span><span class="comment">   *        error::Code::S_EVENT_SET_IMMUTABLE_WHEN_WAITING.</span></div>
<div class="line"><a id="l00461" name="l00461"></a><span class="lineno">  461</span><span class="comment">   * @return `true` if and only if no error occurred (`*err_code` is success).</span></div>
<div class="line"><a id="l00462" name="l00462"></a><span class="lineno">  462</span><span class="comment">   */</span></div>
<div class="line"><a id="l00463" name="l00463"></a><span class="lineno">  463</span>  <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Socket&gt;</div>
<div class="line"><a id="l00464" name="l00464"></a><span class="lineno">  464</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Event__set.html#ac3bd92001ec9ca3623a0e84a50043bb9">remove_wanted_socket</a>(<span class="keyword">typename</span> Socket::Ptr sock, <a class="code hl_enumeration" href="classflow_1_1net__flow_1_1Event__set.html#a19cc3a286c8a11c986d2a59ec1e39a71">Event_type</a> ev_type, <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00465" name="l00465"></a><span class="lineno">  465</span><span class="comment"></span> </div>
<div class="line"><a id="l00466" name="l00466"></a><span class="lineno">  466</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00467" name="l00467"></a><span class="lineno">  467</span><span class="comment">   * Efficiently exchanges the current set of sockets we want to know are &quot;ready&quot; by the definiton of</span></div>
<div class="line"><a id="l00468" name="l00468"></a><span class="lineno">  468</span><span class="comment">   * the given event type.  See individual Event_type enumeration members&#39; doc comments for exact</span></div>
<div class="line"><a id="l00469" name="l00469"></a><span class="lineno">  469</span><span class="comment">   * definition of readiness for each #Event_type.  For example, Event_type::S_PEER_SOCKET_READABLE</span></div>
<div class="line"><a id="l00470" name="l00470"></a><span class="lineno">  470</span><span class="comment">   * means we want to know when `sock-&gt;receive()` would yield either some data or an error, but not</span></div>
<div class="line"><a id="l00471" name="l00471"></a><span class="lineno">  471</span><span class="comment">   * no data and no error.  Use this to perform arbitrarily complex operations on the internal set</span></div>
<div class="line"><a id="l00472" name="l00472"></a><span class="lineno">  472</span><span class="comment">   * storing sockets of interest for the given event type `ev_type`, when the add_wanted_socket() and</span></div>
<div class="line"><a id="l00473" name="l00473"></a><span class="lineno">  473</span><span class="comment">   * remove_wanted_socket() methods are insufficient.  For example:</span></div>
<div class="line"><a id="l00474" name="l00474"></a><span class="lineno">  474</span><span class="comment">   *</span></div>
<div class="line"><a id="l00475" name="l00475"></a><span class="lineno">  475</span><span class="comment">   *   ~~~</span></div>
<div class="line"><a id="l00476" name="l00476"></a><span class="lineno">  476</span><span class="comment">   *   Event_set::Sockets socks;</span></div>
<div class="line"><a id="l00477" name="l00477"></a><span class="lineno">  477</span><span class="comment">   *   // Exchange of our empty `socks` with what&#39;s in `es`.</span></div>
<div class="line"><a id="l00478" name="l00478"></a><span class="lineno">  478</span><span class="comment">   *   es-&gt;swap_wanted_sockets(&amp;socks, Event_type::S_PEER_SOCKET_READBLE);</span></div>
<div class="line"><a id="l00479" name="l00479"></a><span class="lineno">  479</span><span class="comment">   *   // ...Remove every 3rd socket from `socks`, and log `socks.size()`....</span></div>
<div class="line"><a id="l00480" name="l00480"></a><span class="lineno">  480</span><span class="comment">   *   // Now put the modified socket set back into `es`.</span></div>
<div class="line"><a id="l00481" name="l00481"></a><span class="lineno">  481</span><span class="comment">   *   es-&gt;swap_wanted_sockets(&amp;socks, Event_type::S_PEER_SOCKET_READBLE);</span></div>
<div class="line"><a id="l00482" name="l00482"></a><span class="lineno">  482</span><span class="comment">   *   ~~~</span></div>
<div class="line"><a id="l00483" name="l00483"></a><span class="lineno">  483</span><span class="comment">   *</span></div>
<div class="line"><a id="l00484" name="l00484"></a><span class="lineno">  484</span><span class="comment">   * ### Rationale ###</span></div>
<div class="line"><a id="l00485" name="l00485"></a><span class="lineno">  485</span><span class="comment">   * The swap paradigm (precursor to the &quot;move&quot; paradigm added in C++11) allows</span></div>
<div class="line"><a id="l00486" name="l00486"></a><span class="lineno">  486</span><span class="comment">   * arbitrarily complex operations without sacrificing performance or thread safety.</span></div>
<div class="line"><a id="l00487" name="l00487"></a><span class="lineno">  487</span><span class="comment">   *</span></div>
<div class="line"><a id="l00488" name="l00488"></a><span class="lineno">  488</span><span class="comment">   * @param target_set</span></div>
<div class="line"><a id="l00489" name="l00489"></a><span class="lineno">  489</span><span class="comment">   *        Pointer to set of sockets to which to load the current internal set.  Currently</span></div>
<div class="line"><a id="l00490" name="l00490"></a><span class="lineno">  490</span><span class="comment">   *        contained sockets must be from the same Node that originated this Event_set.</span></div>
<div class="line"><a id="l00491" name="l00491"></a><span class="lineno">  491</span><span class="comment">   * @param ev_type</span></div>
<div class="line"><a id="l00492" name="l00492"></a><span class="lineno">  492</span><span class="comment">   *        See add_wanted_socket().</span></div>
<div class="line"><a id="l00493" name="l00493"></a><span class="lineno">  493</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00494" name="l00494"></a><span class="lineno">  494</span><span class="comment">   *        See flow::Error_code docs for error reporting semantics.  Generated codes:</span></div>
<div class="line"><a id="l00495" name="l00495"></a><span class="lineno">  495</span><span class="comment">   *        error::Code::S_EVENT_SET_CLOSED, error::Code::S_EVENT_SET_IMMUTABLE_WHEN_WAITING.</span></div>
<div class="line"><a id="l00496" name="l00496"></a><span class="lineno">  496</span><span class="comment">   * @return `true` if and only if no error occurred (`*err_code` is success).</span></div>
<div class="line"><a id="l00497" name="l00497"></a><span class="lineno">  497</span><span class="comment">   */</span></div>
<div class="line"><a id="l00498" name="l00498"></a><span class="lineno">  498</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Event__set.html#a6e47fc394c09acf4d100a640e090a7aa">swap_wanted_sockets</a>(<a class="code hl_class" href="classflow_1_1util_1_1Linked__hash__set.html">Sockets</a>* target_set, <a class="code hl_enumeration" href="classflow_1_1net__flow_1_1Event__set.html#a19cc3a286c8a11c986d2a59ec1e39a71">Event_type</a> ev_type, <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code);</div>
<div class="line"><a id="l00499" name="l00499"></a><span class="lineno">  499</span><span class="comment"></span> </div>
<div class="line"><a id="l00500" name="l00500"></a><span class="lineno">  500</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00501" name="l00501"></a><span class="lineno">  501</span><span class="comment">   * Identical to `swap_wanted_sockets(&amp;sockets, ev_type, err_code)`, where originally `sockets` is empty and</span></div>
<div class="line"><a id="l00502" name="l00502"></a><span class="lineno">  502</span><span class="comment">   * is afterwards cleared; but more efficient.</span></div>
<div class="line"><a id="l00503" name="l00503"></a><span class="lineno">  503</span><span class="comment">   *</span></div>
<div class="line"><a id="l00504" name="l00504"></a><span class="lineno">  504</span><span class="comment">   * @param ev_type</span></div>
<div class="line"><a id="l00505" name="l00505"></a><span class="lineno">  505</span><span class="comment">   *        See swap_wanted_sockets().</span></div>
<div class="line"><a id="l00506" name="l00506"></a><span class="lineno">  506</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00507" name="l00507"></a><span class="lineno">  507</span><span class="comment">   *        See flow::Error_code docs for error reporting semantics.  Generated codes:</span></div>
<div class="line"><a id="l00508" name="l00508"></a><span class="lineno">  508</span><span class="comment">   *        error::Code::S_EVENT_SET_CLOSED, error::Code::S_EVENT_SET_IMMUTABLE_WHEN_WAITING.</span></div>
<div class="line"><a id="l00509" name="l00509"></a><span class="lineno">  509</span><span class="comment">   * @return `true` if and only if no error occurred (`*err_code` is success).</span></div>
<div class="line"><a id="l00510" name="l00510"></a><span class="lineno">  510</span><span class="comment">   */</span></div>
<div class="line"><a id="l00511" name="l00511"></a><span class="lineno">  511</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Event__set.html#a86ddd6fb8874d85869157bae2ffda69b">clear_wanted_sockets</a>(<a class="code hl_enumeration" href="classflow_1_1net__flow_1_1Event__set.html#a19cc3a286c8a11c986d2a59ec1e39a71">Event_type</a> ev_type, <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00512" name="l00512"></a><span class="lineno">  512</span><span class="comment"></span> </div>
<div class="line"><a id="l00513" name="l00513"></a><span class="lineno">  513</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00514" name="l00514"></a><span class="lineno">  514</span><span class="comment">   * Returns `true` if and only if at least one wanted event for at least one socket is registered</span></div>
<div class="line"><a id="l00515" name="l00515"></a><span class="lineno">  515</span><span class="comment">   * (via add_wanted_socket(), swap_wanted_sockets(), etc.).</span></div>
<div class="line"><a id="l00516" name="l00516"></a><span class="lineno">  516</span><span class="comment">   *</span></div>
<div class="line"><a id="l00517" name="l00517"></a><span class="lineno">  517</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00518" name="l00518"></a><span class="lineno">  518</span><span class="comment">   *        See flow::Error_code docs for error reporting semantics.  Generated codes:</span></div>
<div class="line"><a id="l00519" name="l00519"></a><span class="lineno">  519</span><span class="comment">   *        error::Code::S_EVENT_SET_CLOSED.</span></div>
<div class="line"><a id="l00520" name="l00520"></a><span class="lineno">  520</span><span class="comment">   * @return `true` if there are wanted events; `false` if there are no wanted events (then `*err_code` is</span></div>
<div class="line"><a id="l00521" name="l00521"></a><span class="lineno">  521</span><span class="comment">   *         success) or there was an error (`*err_code` is failure; i.e., `bool(*err_code) == true`).</span></div>
<div class="line"><a id="l00522" name="l00522"></a><span class="lineno">  522</span><span class="comment">   */</span></div>
<div class="line"><a id="l00523" name="l00523"></a><span class="lineno">  523</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Event__set.html#a976144f6e525190344eb4e51620f9fd9">events_wanted</a>(<a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code = 0) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00524" name="l00524"></a><span class="lineno">  524</span><span class="comment"></span> </div>
<div class="line"><a id="l00525" name="l00525"></a><span class="lineno">  525</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00526" name="l00526"></a><span class="lineno">  526</span><span class="comment">   * Checks for all previously described events that currently hold, saves them for retrieval via</span></div>
<div class="line"><a id="l00527" name="l00527"></a><span class="lineno">  527</span><span class="comment">   * emit_result_sockets(), etc., and returns.  This is akin to a non-blocking sync_wait() (which does</span></div>
<div class="line"><a id="l00528" name="l00528"></a><span class="lineno">  528</span><span class="comment">   * not exist; poll() does), a/k/a a `select()` with a timeout of zero.</span></div>
<div class="line"><a id="l00529" name="l00529"></a><span class="lineno">  529</span><span class="comment">   *</span></div>
<div class="line"><a id="l00530" name="l00530"></a><span class="lineno">  530</span><span class="comment">   * In a non-error invocation, state() will be State::S_INACTIVE before and after the call.  In an error</span></div>
<div class="line"><a id="l00531" name="l00531"></a><span class="lineno">  531</span><span class="comment">   * invocation, state() will not change.</span></div>
<div class="line"><a id="l00532" name="l00532"></a><span class="lineno">  532</span><span class="comment">   *</span></div>
<div class="line"><a id="l00533" name="l00533"></a><span class="lineno">  533</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00534" name="l00534"></a><span class="lineno">  534</span><span class="comment">   *        See flow::Error_code docs for error reporting semantics.  Generated codes:</span></div>
<div class="line"><a id="l00535" name="l00535"></a><span class="lineno">  535</span><span class="comment">   *        error::Code::S_EVENT_SET_CLOSED, error::Code::S_EVENT_SET_DOUBLE_WAIT_OR_POLL.</span></div>
<div class="line"><a id="l00536" name="l00536"></a><span class="lineno">  536</span><span class="comment">   * @return `true` if and only if no error occurred (`*err_code` is success).</span></div>
<div class="line"><a id="l00537" name="l00537"></a><span class="lineno">  537</span><span class="comment">   */</span></div>
<div class="line"><a id="l00538" name="l00538"></a><span class="lineno">  538</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Event__set.html#a412214de6a4f3a1ff1e86ddb1975f47b">poll</a>(<a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00539" name="l00539"></a><span class="lineno">  539</span><span class="comment"></span> </div>
<div class="line"><a id="l00540" name="l00540"></a><span class="lineno">  540</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00541" name="l00541"></a><span class="lineno">  541</span><span class="comment">   * Blocks indefinitely until one or more of the previously described events hold -- or the wait</span></div>
<div class="line"><a id="l00542" name="l00542"></a><span class="lineno">  542</span><span class="comment">   * is interrupted; saves them for retrieval via emit_result_sockets(), etc.; and returns.</span></div>
<div class="line"><a id="l00543" name="l00543"></a><span class="lineno">  543</span><span class="comment">   * This is akin to a `select()` call with no (i.e., infinite) timeout.</span></div>
<div class="line"><a id="l00544" name="l00544"></a><span class="lineno">  544</span><span class="comment">   *</span></div>
<div class="line"><a id="l00545" name="l00545"></a><span class="lineno">  545</span><span class="comment">   * The special case of Node::interrupt_all_waits() interrupting this wait -- which is conceptually similar</span></div>
<div class="line"><a id="l00546" name="l00546"></a><span class="lineno">  546</span><span class="comment">   * to `EINTR` in POSIX -- manifests itself as error::Code::S_WAIT_INTERRUPTED.  In this case,</span></div>
<div class="line"><a id="l00547" name="l00547"></a><span class="lineno">  547</span><span class="comment">   * emit_result_sockets() (etc.) should not be used, as one should assume no events are active due to the</span></div>
<div class="line"><a id="l00548" name="l00548"></a><span class="lineno">  548</span><span class="comment">   * interruption.</span></div>
<div class="line"><a id="l00549" name="l00549"></a><span class="lineno">  549</span><span class="comment">   *</span></div>
<div class="line"><a id="l00550" name="l00550"></a><span class="lineno">  550</span><span class="comment">   * In a non-error invocation, state() will be State::S_INACTIVE before and after the call, unless</span></div>
<div class="line"><a id="l00551" name="l00551"></a><span class="lineno">  551</span><span class="comment">   * underlying Node is destroyed, in which case the final state may be State::S_CLOSED.  In an error</span></div>
<div class="line"><a id="l00552" name="l00552"></a><span class="lineno">  552</span><span class="comment">   * invocation, state() will not change, and the method will return immediately.  Additionally, the</span></div>
<div class="line"><a id="l00553" name="l00553"></a><span class="lineno">  553</span><span class="comment">   * method will NEVER return, if another thread calls `this-&gt;close()` or `this-&gt;async_wait_finish()`</span></div>
<div class="line"><a id="l00554" name="l00554"></a><span class="lineno">  554</span><span class="comment">   * during this sync_wait() (so don&#39;t do that).</span></div>
<div class="line"><a id="l00555" name="l00555"></a><span class="lineno">  555</span><span class="comment">   *</span></div>
<div class="line"><a id="l00556" name="l00556"></a><span class="lineno">  556</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00557" name="l00557"></a><span class="lineno">  557</span><span class="comment">   *        See flow::Error_code docs for error reporting semantics.  Generated codes:</span></div>
<div class="line"><a id="l00558" name="l00558"></a><span class="lineno">  558</span><span class="comment">   *        error::Code::S_WAIT_INTERRUPTED, error::Code::S_EVENT_SET_NO_EVENTS,</span></div>
<div class="line"><a id="l00559" name="l00559"></a><span class="lineno">  559</span><span class="comment">   *        error::Code::S_EVENT_SET_DOUBLE_WAIT_OR_POLL, error::Code::S_EVENT_SET_CLOSED.</span></div>
<div class="line"><a id="l00560" name="l00560"></a><span class="lineno">  560</span><span class="comment">   * @return `true` if and only if no error occurred (`*err_code` is success).</span></div>
<div class="line"><a id="l00561" name="l00561"></a><span class="lineno">  561</span><span class="comment">   */</span></div>
<div class="line"><a id="l00562" name="l00562"></a><span class="lineno">  562</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Event__set.html#a133c518168fe3922ab6729a99077dd3f">sync_wait</a>(<a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00563" name="l00563"></a><span class="lineno">  563</span><span class="comment"></span> </div>
<div class="line"><a id="l00564" name="l00564"></a><span class="lineno">  564</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00565" name="l00565"></a><span class="lineno">  565</span><span class="comment">   * Same as the other sync_wait() but will stop waiting if the timeout given as argument</span></div>
<div class="line"><a id="l00566" name="l00566"></a><span class="lineno">  566</span><span class="comment">   * expires.  If the timeout expires, it is the error code error::Code::S_WAIT_USER_TIMEOUT.  This is akin</span></div>
<div class="line"><a id="l00567" name="l00567"></a><span class="lineno">  567</span><span class="comment">   * to a `select()` call with a finite timeout.</span></div>
<div class="line"><a id="l00568" name="l00568"></a><span class="lineno">  568</span><span class="comment">   *</span></div>
<div class="line"><a id="l00569" name="l00569"></a><span class="lineno">  569</span><span class="comment">   * An additional error situation is possible in addition to that described in the 2nd/3rd paragraphs of</span></div>
<div class="line"><a id="l00570" name="l00570"></a><span class="lineno">  570</span><span class="comment">   * the other sync_wait()&#39;s doc header: if this is `close()`d during the wait, and the wait</span></div>
<div class="line"><a id="l00571" name="l00571"></a><span class="lineno">  571</span><span class="comment">   * times out, error::Code::S_EVENT_SET_CLOSED will be emitted when this timeout is detected.  On the</span></div>
<div class="line"><a id="l00572" name="l00572"></a><span class="lineno">  572</span><span class="comment">   * positive side, that means `sync_wait(timeout)` will eventually exit no matter what.</span></div>
<div class="line"><a id="l00573" name="l00573"></a><span class="lineno">  573</span><span class="comment">   *</span></div>
<div class="line"><a id="l00574" name="l00574"></a><span class="lineno">  574</span><span class="comment">   * Tip: Typical types you might use for `max_wait`: `boost::chrono::milliseconds`,</span></div>
<div class="line"><a id="l00575" name="l00575"></a><span class="lineno">  575</span><span class="comment">   * `boost::chrono::seconds`, `boost::chrono::high_resolution_clock::duration`.</span></div>
<div class="line"><a id="l00576" name="l00576"></a><span class="lineno">  576</span><span class="comment">   *</span></div>
<div class="line"><a id="l00577" name="l00577"></a><span class="lineno">  577</span><span class="comment">   * No guarantees are made as to the accuracy of the timeout timer, although you can optimistically</span></div>
<div class="line"><a id="l00578" name="l00578"></a><span class="lineno">  578</span><span class="comment">   * provide arbitrarily precise values for `max_wait`.</span></div>
<div class="line"><a id="l00579" name="l00579"></a><span class="lineno">  579</span><span class="comment">   *</span></div>
<div class="line"><a id="l00580" name="l00580"></a><span class="lineno">  580</span><span class="comment">   * @tparam Rep</span></div>
<div class="line"><a id="l00581" name="l00581"></a><span class="lineno">  581</span><span class="comment">   *         See `boost::chrono::duration` documentation (and see above tip).</span></div>
<div class="line"><a id="l00582" name="l00582"></a><span class="lineno">  582</span><span class="comment">   * @tparam Period</span></div>
<div class="line"><a id="l00583" name="l00583"></a><span class="lineno">  583</span><span class="comment">   *         See `boost::chrono::duration` documentation (and see above tip).</span></div>
<div class="line"><a id="l00584" name="l00584"></a><span class="lineno">  584</span><span class="comment">   * @param max_wait</span></div>
<div class="line"><a id="l00585" name="l00585"></a><span class="lineno">  585</span><span class="comment">   *        The maximum amount of time from now to wait before giving up on the wait and returning.</span></div>
<div class="line"><a id="l00586" name="l00586"></a><span class="lineno">  586</span><span class="comment">   *        `&quot;duration&lt;Rep, Period&gt;::max()&quot;` will eliminate the time limit and cause indefinite wait.</span></div>
<div class="line"><a id="l00587" name="l00587"></a><span class="lineno">  587</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00588" name="l00588"></a><span class="lineno">  588</span><span class="comment">   *        See flow::Error_code docs for error reporting semantics.  Generated codes:</span></div>
<div class="line"><a id="l00589" name="l00589"></a><span class="lineno">  589</span><span class="comment">   *        Same as the other sync_wait() plus: error::Code::S_WAIT_USER_TIMEOUT.</span></div>
<div class="line"><a id="l00590" name="l00590"></a><span class="lineno">  590</span><span class="comment">   * @return `true` if and only if no error occurred (`*err_code` is success).  Timeout expiring IS</span></div>
<div class="line"><a id="l00591" name="l00591"></a><span class="lineno">  591</span><span class="comment">   *         an error, in particular.</span></div>
<div class="line"><a id="l00592" name="l00592"></a><span class="lineno">  592</span><span class="comment">   */</span></div>
<div class="line"><a id="l00593" name="l00593"></a><span class="lineno">  593</span>  <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Rep, <span class="keyword">typename</span> Period&gt;</div>
<div class="line"><a id="l00594" name="l00594"></a><span class="lineno">  594</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Event__set.html#a133c518168fe3922ab6729a99077dd3f">sync_wait</a>(<span class="keyword">const</span> boost::chrono::duration&lt;Rep, Period&gt;&amp; max_wait, <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00595" name="l00595"></a><span class="lineno">  595</span><span class="comment"></span> </div>
<div class="line"><a id="l00596" name="l00596"></a><span class="lineno">  596</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00597" name="l00597"></a><span class="lineno">  597</span><span class="comment">   * Moves object to State::S_WAITING state, saves the given handler to be executed later (in a different,</span></div>
<div class="line"><a id="l00598" name="l00598"></a><span class="lineno">  598</span><span class="comment">   * unspecified thread), when one or more of the previously described events hold; and immediately</span></div>
<div class="line"><a id="l00599" name="l00599"></a><span class="lineno">  599</span><span class="comment">   * returns.  State will go back to State::S_INACTIVE when the handler fires; or when async_wait_finish() is</span></div>
<div class="line"><a id="l00600" name="l00600"></a><span class="lineno">  600</span><span class="comment">   * called by the user (whichever happens first).  State may also change to State::S_CLOSED if `this-&gt;close()` is</span></div>
<div class="line"><a id="l00601" name="l00601"></a><span class="lineno">  601</span><span class="comment">   * called, or the Node is destroyed.  The saved handler will be forgotten at that time.  Once</span></div>
<div class="line"><a id="l00602" name="l00602"></a><span class="lineno">  602</span><span class="comment">   * INACTIVE is entered, emit_result_sockets(), etc., are to be used to access the detected</span></div>
<div class="line"><a id="l00603" name="l00603"></a><span class="lineno">  603</span><span class="comment">   * events.  on_event() must take one bool argument.  If this argument is `false`, use emit_result_sockets(),</span></div>
<div class="line"><a id="l00604" name="l00604"></a><span class="lineno">  604</span><span class="comment">   * etc., to access the detected events.  If this argument is `true`, then Node::interrupt_all_waits() was</span></div>
<div class="line"><a id="l00605" name="l00605"></a><span class="lineno">  605</span><span class="comment">   * invoked and has interrupted this wait (conceptually similar to `EINTR` in POSIX).  In the latter case,</span></div>
<div class="line"><a id="l00606" name="l00606"></a><span class="lineno">  606</span><span class="comment">   * do no use emit_result_sockets(), etc., as no events are active due to the interruption.</span></div>
<div class="line"><a id="l00607" name="l00607"></a><span class="lineno">  607</span><span class="comment">   *</span></div>
<div class="line"><a id="l00608" name="l00608"></a><span class="lineno">  608</span><span class="comment">   * In a non-error invocation, state() will be INACTIVE before the call and WAITING after it.</span></div>
<div class="line"><a id="l00609" name="l00609"></a><span class="lineno">  609</span><span class="comment">   * In an error invocation, state() will not change, and the method will return immediately.</span></div>
<div class="line"><a id="l00610" name="l00610"></a><span class="lineno">  610</span><span class="comment">   * Additionally, on_event() will NEVER be called, if another thread calls `this-&gt;close()` before</span></div>
<div class="line"><a id="l00611" name="l00611"></a><span class="lineno">  611</span><span class="comment">   * async_wait_finish() is called, and before the Node is destroyed.  So don&#39;t do that.</span></div>
<div class="line"><a id="l00612" name="l00612"></a><span class="lineno">  612</span><span class="comment">   *</span></div>
<div class="line"><a id="l00613" name="l00613"></a><span class="lineno">  613</span><span class="comment">   * Restrictions on what `on_event()` is allowed to do: It is allowed to do anything except make any</span></div>
<div class="line"><a id="l00614" name="l00614"></a><span class="lineno">  614</span><span class="comment">   * `net_flow` call related to the net_flow::Node originating the current Event_set; doing so results in</span></div>
<div class="line"><a id="l00615" name="l00615"></a><span class="lineno">  615</span><span class="comment">   * undefined behavior.  Informally, it also must not block; spending significant time in</span></div>
<div class="line"><a id="l00616" name="l00616"></a><span class="lineno">  616</span><span class="comment">   * `on_event()` will disrupt the functionality of the Node.  Even more informally, the goal of</span></div>
<div class="line"><a id="l00617" name="l00617"></a><span class="lineno">  617</span><span class="comment">   * `on_event()` should be to quickly signal the user&#39;s thread(s) that the events hold (using the</span></div>
<div class="line"><a id="l00618" name="l00618"></a><span class="lineno">  618</span><span class="comment">   * technique of the user&#39;s choice) and then return -- beyond that, the handling of the ready events</span></div>
<div class="line"><a id="l00619" name="l00619"></a><span class="lineno">  619</span><span class="comment">   * should be in the user&#39;s thread(s).</span></div>
<div class="line"><a id="l00620" name="l00620"></a><span class="lineno">  620</span><span class="comment">   *</span></div>
<div class="line"><a id="l00621" name="l00621"></a><span class="lineno">  621</span><span class="comment">   * Tip: Call async_wait_finish() before checking the saved results, using emit_result_sockets().  Doing so BEFORE</span></div>
<div class="line"><a id="l00622" name="l00622"></a><span class="lineno">  622</span><span class="comment">   * any events are detected will finish this asynchronous wait.  Doing so AFTER any events are</span></div>
<div class="line"><a id="l00623" name="l00623"></a><span class="lineno">  623</span><span class="comment">   * detected will be a harmless NOOP.</span></div>
<div class="line"><a id="l00624" name="l00624"></a><span class="lineno">  624</span><span class="comment">   *</span></div>
<div class="line"><a id="l00625" name="l00625"></a><span class="lineno">  625</span><span class="comment">   * Tip: Use lambdas (or `bind()`) to make async_wait() asynchronously call any arbitrary function</span></div>
<div class="line"><a id="l00626" name="l00626"></a><span class="lineno">  626</span><span class="comment">   * or method with any arbitrary arguments -- NOT just a free `void` function with 1 argument.  Outside the scope</span></div>
<div class="line"><a id="l00627" name="l00627"></a><span class="lineno">  627</span><span class="comment">   * of discussion here, but if this doesn&#39;t ring a bell, please look into lambdas (`bind()` as a backup).</span></div>
<div class="line"><a id="l00628" name="l00628"></a><span class="lineno">  628</span><span class="comment">   *</span></div>
<div class="line"><a id="l00629" name="l00629"></a><span class="lineno">  629</span><span class="comment">   * Rationale for no timeout argument: Since the caller of async_wait() retains flow control</span></div>
<div class="line"><a id="l00630" name="l00630"></a><span class="lineno">  630</span><span class="comment">   * without blocking, the user code can enforce its own timeout logic, if necessary, and simply</span></div>
<div class="line"><a id="l00631" name="l00631"></a><span class="lineno">  631</span><span class="comment">   * call async_wait_finish() when desired.  In fact that is just what sync_wait() (with timeout argument) does</span></div>
<div class="line"><a id="l00632" name="l00632"></a><span class="lineno">  632</span><span class="comment">   * internally.</span></div>
<div class="line"><a id="l00633" name="l00633"></a><span class="lineno">  633</span><span class="comment">   *</span></div>
<div class="line"><a id="l00634" name="l00634"></a><span class="lineno">  634</span><span class="comment">   * @param on_event</span></div>
<div class="line"><a id="l00635" name="l00635"></a><span class="lineno">  635</span><span class="comment">   *        The function to call as soon as as one or more events previously described hold, AND</span></div>
<div class="line"><a id="l00636" name="l00636"></a><span class="lineno">  636</span><span class="comment">   *        `this-&gt;state()` is still State::S_WAITING.  (Also see above tip.)</span></div>
<div class="line"><a id="l00637" name="l00637"></a><span class="lineno">  637</span><span class="comment">   *        `on_event(bool was_interrupted)` will be called.</span></div>
<div class="line"><a id="l00638" name="l00638"></a><span class="lineno">  638</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00639" name="l00639"></a><span class="lineno">  639</span><span class="comment">   *        See flow::Error_code docs for error reporting semantics.  Generated codes:</span></div>
<div class="line"><a id="l00640" name="l00640"></a><span class="lineno">  640</span><span class="comment">   *        error::Code::S_EVENT_SET_DOUBLE_WAIT_OR_POLL, error::Code::S_EVENT_SET_CLOSED.</span></div>
<div class="line"><a id="l00641" name="l00641"></a><span class="lineno">  641</span><span class="comment">   * @return `true` if and only if no error occurred (`*err_code` is success).</span></div>
<div class="line"><a id="l00642" name="l00642"></a><span class="lineno">  642</span><span class="comment">   */</span></div>
<div class="line"><a id="l00643" name="l00643"></a><span class="lineno">  643</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Event__set.html#a43dfb881ab3a9488a6a60dd83ad21c85">async_wait</a>(<span class="keyword">const</span> <a class="code hl_class" href="classflow_1_1Function.html">Event_handler</a>&amp; on_event, <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00644" name="l00644"></a><span class="lineno">  644</span><span class="comment"></span> </div>
<div class="line"><a id="l00645" name="l00645"></a><span class="lineno">  645</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00646" name="l00646"></a><span class="lineno">  646</span><span class="comment">   * Moves object from State::S_WAITING to State::S_INACTIVE, and forgets any handler saved by async_wait(), or does</span></div>
<div class="line"><a id="l00647" name="l00647"></a><span class="lineno">  647</span><span class="comment">   * nothing if state is already INACTIVE.  Use this to cut short an asynchronous wait started by</span></div>
<div class="line"><a id="l00648" name="l00648"></a><span class="lineno">  648</span><span class="comment">   * async_wait().  After return, emit_result_sockets(), etc., can be used to check the active</span></div>
<div class="line"><a id="l00649" name="l00649"></a><span class="lineno">  649</span><span class="comment">   * events (if any) detected during the last wait.</span></div>
<div class="line"><a id="l00650" name="l00650"></a><span class="lineno">  650</span><span class="comment">   *</span></div>
<div class="line"><a id="l00651" name="l00651"></a><span class="lineno">  651</span><span class="comment">   * In a non-error invocation, state() will be State::S_INACTIVE or State::S_WAITING before the call and</span></div>
<div class="line"><a id="l00652" name="l00652"></a><span class="lineno">  652</span><span class="comment">   * State::S_INACTIVE after it.  In an error invocation, state() will not change.</span></div>
<div class="line"><a id="l00653" name="l00653"></a><span class="lineno">  653</span><span class="comment">   *</span></div>
<div class="line"><a id="l00654" name="l00654"></a><span class="lineno">  654</span><span class="comment">   * You might call async_wait_finish() while another thread is executing a timeout-less sync_wait()</span></div>
<div class="line"><a id="l00655" name="l00655"></a><span class="lineno">  655</span><span class="comment">   * (which is also invoked by blocking methods like Peer_socket::sync_receive()).  However that</span></div>
<div class="line"><a id="l00656" name="l00656"></a><span class="lineno">  656</span><span class="comment">   * will cause that sync_wait() to NEVER return.  So don&#39;t do that.</span></div>
<div class="line"><a id="l00657" name="l00657"></a><span class="lineno">  657</span><span class="comment">   *</span></div>
<div class="line"><a id="l00658" name="l00658"></a><span class="lineno">  658</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00659" name="l00659"></a><span class="lineno">  659</span><span class="comment">   *        See flow::Error_code docs for error reporting semantics.  Generated codes:</span></div>
<div class="line"><a id="l00660" name="l00660"></a><span class="lineno">  660</span><span class="comment">   *        error::Code::S_EVENT_SET_CLOSED.</span></div>
<div class="line"><a id="l00661" name="l00661"></a><span class="lineno">  661</span><span class="comment">   * @return `true` if and only if no error occurred (`*err_code` is success).  In particular, state()</span></div>
<div class="line"><a id="l00662" name="l00662"></a><span class="lineno">  662</span><span class="comment">   *         being State::S_INACTIVE when the method starts is not an error.</span></div>
<div class="line"><a id="l00663" name="l00663"></a><span class="lineno">  663</span><span class="comment">   */</span></div>
<div class="line"><a id="l00664" name="l00664"></a><span class="lineno">  664</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Event__set.html#a3122100c044da08495fac737998f60db">async_wait_finish</a>(<a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00665" name="l00665"></a><span class="lineno">  665</span><span class="comment"></span> </div>
<div class="line"><a id="l00666" name="l00666"></a><span class="lineno">  666</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00667" name="l00667"></a><span class="lineno">  667</span><span class="comment">   * Returns `true` if and only if the last wait, if any, detected at least one event.  In other</span></div>
<div class="line"><a id="l00668" name="l00668"></a><span class="lineno">  668</span><span class="comment">   * words, returns `true` if and only if emit_result_sockets() would currently emit at least one</span></div>
<div class="line"><a id="l00669" name="l00669"></a><span class="lineno">  669</span><span class="comment">   * socket, if tried with all possible Event_type.</span></div>
<div class="line"><a id="l00670" name="l00670"></a><span class="lineno">  670</span><span class="comment">   *</span></div>
<div class="line"><a id="l00671" name="l00671"></a><span class="lineno">  671</span><span class="comment">   * One can still use `emit_result_sockets()` to get the specific events after calling this.</span></div>
<div class="line"><a id="l00672" name="l00672"></a><span class="lineno">  672</span><span class="comment">   *</span></div>
<div class="line"><a id="l00673" name="l00673"></a><span class="lineno">  673</span><span class="comment">   * @note Conceptually, this is a bit like when `select()` returns 0 or higher; and one uses the check</span></div>
<div class="line"><a id="l00674" name="l00674"></a><span class="lineno">  674</span><span class="comment">   *       of whether its return value is 0 or non-zero.  Non-zero is actually some complex index thing,</span></div>
<div class="line"><a id="l00675" name="l00675"></a><span class="lineno">  675</span><span class="comment">   *       but often that detail is not necessary (much like `emit_result_sockets()` is unnecessary, analogously),</span></div>
<div class="line"><a id="l00676" name="l00676"></a><span class="lineno">  676</span><span class="comment">   *       as the mere presence or absence of 1+ events is enough information.  For example, if only one event</span></div>
<div class="line"><a id="l00677" name="l00677"></a><span class="lineno">  677</span><span class="comment">   *       for one socket is being waited on, one can check this and confidently perform the appropriate I/O</span></div>
<div class="line"><a id="l00678" name="l00678"></a><span class="lineno">  678</span><span class="comment">   *       operation for that one socket, if and only if this returns `true` -- or `select()` would return</span></div>
<div class="line"><a id="l00679" name="l00679"></a><span class="lineno">  679</span><span class="comment">   *       non-zero.  Slightly more wastefully, but still not bad at all, is when (say) 2 event types are being</span></div>
<div class="line"><a id="l00680" name="l00680"></a><span class="lineno">  680</span><span class="comment">   *       waited on, but for only 1 socket.  In that case `true` return =&gt; just perform both I/O operations;</span></div>
<div class="line"><a id="l00681" name="l00681"></a><span class="lineno">  681</span><span class="comment">   *       one OR both of them should yield something (and the one that doesn&#39;t hardly uses any resources).</span></div>
<div class="line"><a id="l00682" name="l00682"></a><span class="lineno">  682</span><span class="comment">   *       Similarly, even if you&#39;re waiting on a few sockets, if it&#39;s a limited number (like, say, 2-3), then</span></div>
<div class="line"><a id="l00683" name="l00683"></a><span class="lineno">  683</span><span class="comment">   *       indiscriminately trying all possible I/O on all 2-3 sockets is only slightly wasteful: and the code</span></div>
<div class="line"><a id="l00684" name="l00684"></a><span class="lineno">  684</span><span class="comment">   *       is quite a bit shorter than carefully checking `emit_result_sockets()` (or doing `FD_ISSET()`, etc., in</span></div>
<div class="line"><a id="l00685" name="l00685"></a><span class="lineno">  685</span><span class="comment">   *       the analogous `select()` code).</span></div>
<div class="line"><a id="l00686" name="l00686"></a><span class="lineno">  686</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00687" name="l00687"></a><span class="lineno">  687</span><span class="comment">   *        See flow::Error_code docs for error reporting semantics.  Generated codes:</span></div>
<div class="line"><a id="l00688" name="l00688"></a><span class="lineno">  688</span><span class="comment">   *        error::Code::S_EVENT_SET_CLOSED, error::Code::S_EVENT_SET_RESULT_CHECK_WHEN_WAITING.</span></div>
<div class="line"><a id="l00689" name="l00689"></a><span class="lineno">  689</span><span class="comment">   * @return `true` if there are active events; `false` if there are no active events (then `*err_code` is</span></div>
<div class="line"><a id="l00690" name="l00690"></a><span class="lineno">  690</span><span class="comment">   *         success) or there was an error (`*err_code` is failure; i.e., `bool(*err_code) == true`).</span></div>
<div class="line"><a id="l00691" name="l00691"></a><span class="lineno">  691</span><span class="comment">   */</span></div>
<div class="line"><a id="l00692" name="l00692"></a><span class="lineno">  692</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Event__set.html#a314635daf8fdf3805868baff8b42cfc9">events_detected</a>(<a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code = 0) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00693" name="l00693"></a><span class="lineno">  693</span><span class="comment"></span> </div>
<div class="line"><a id="l00694" name="l00694"></a><span class="lineno">  694</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00695" name="l00695"></a><span class="lineno">  695</span><span class="comment">   * Gets the sockets that satisfy the condition of the given Event_type detected during the last wait.</span></div>
<div class="line"><a id="l00696" name="l00696"></a><span class="lineno">  696</span><span class="comment">   * More precisely, moves all sockets satisfying that condition detected during the last wait (if any)</span></div>
<div class="line"><a id="l00697" name="l00697"></a><span class="lineno">  697</span><span class="comment">   * into the set provided by the user.  Because it is a move (for efficiency among other reasons), the</span></div>
<div class="line"><a id="l00698" name="l00698"></a><span class="lineno">  698</span><span class="comment">   * subsequent calls to the same method will yield empty sets (until the next wait operation).</span></div>
<div class="line"><a id="l00699" name="l00699"></a><span class="lineno">  699</span><span class="comment">   * Calling before any wait will also yield an empty set.</span></div>
<div class="line"><a id="l00700" name="l00700"></a><span class="lineno">  700</span><span class="comment">   *</span></div>
<div class="line"><a id="l00701" name="l00701"></a><span class="lineno">  701</span><span class="comment">   * Note that the accumulated sockets are NOT preserved across waits.  That is, if you</span></div>
<div class="line"><a id="l00702" name="l00702"></a><span class="lineno">  702</span><span class="comment">   * start a wait, the preceding wait&#39;s results are wiped out.</span></div>
<div class="line"><a id="l00703" name="l00703"></a><span class="lineno">  703</span><span class="comment">   *</span></div>
<div class="line"><a id="l00704" name="l00704"></a><span class="lineno">  704</span><span class="comment">   * ### Rationale ###</span></div>
<div class="line"><a id="l00705" name="l00705"></a><span class="lineno">  705</span><span class="comment">   * Making the method a one-off that returns nothing after the first invocation (per</span></div>
<div class="line"><a id="l00706" name="l00706"></a><span class="lineno">  706</span><span class="comment">   * wait) allows for thread safety without sacrificing efficiency by adding set copy.</span></div>
<div class="line"><a id="l00707" name="l00707"></a><span class="lineno">  707</span><span class="comment">   *</span></div>
<div class="line"><a id="l00708" name="l00708"></a><span class="lineno">  708</span><span class="comment">   * ### How to use ###</span></div>
<div class="line"><a id="l00709" name="l00709"></a><span class="lineno">  709</span><span class="comment">   * First, prepare a (usually empty) target socket set structure.  Second, call emit_result_sockets() to transfer</span></div>
<div class="line"><a id="l00710" name="l00710"></a><span class="lineno">  710</span><span class="comment">   * the results to it.  Third, for each socket of interest, `any_cast&lt;&gt;` it from `boost::any` to the</span></div>
<div class="line"><a id="l00711" name="l00711"></a><span class="lineno">  711</span><span class="comment">   * socket pointer of the appropriate type.  (Recall that `boost::any` stores an object of any type</span></div>
<div class="line"><a id="l00712" name="l00712"></a><span class="lineno">  712</span><span class="comment">   * inside it, so to get access to that you must know to what to cast it; but this is easy, since by</span></div>
<div class="line"><a id="l00713" name="l00713"></a><span class="lineno">  713</span><span class="comment">   * specifying `ev_type` you are implying a certain socket type.)  Example:</span></div>
<div class="line"><a id="l00714" name="l00714"></a><span class="lineno">  714</span><span class="comment">   *</span></div>
<div class="line"><a id="l00715" name="l00715"></a><span class="lineno">  715</span><span class="comment">   *   ~~~</span></div>
<div class="line"><a id="l00716" name="l00716"></a><span class="lineno">  716</span><span class="comment">   *   Event_set::Sockets readable_socks; // Note this contains boost::any&#39;s as elements, regardless of `ev_type`.</span></div>
<div class="line"><a id="l00717" name="l00717"></a><span class="lineno">  717</span><span class="comment">   *   event_set-&gt;emit_result_sockets(&amp;readable_socks, Event_set::Event_type::S_PEER_SOCKET_READABLE);</span></div>
<div class="line"><a id="l00718" name="l00718"></a><span class="lineno">  718</span><span class="comment">   *   for (const auto&amp; readable_sock_as_any : readable_socks)</span></div>
<div class="line"><a id="l00719" name="l00719"></a><span class="lineno">  719</span><span class="comment">   *   {</span></div>
<div class="line"><a id="l00720" name="l00720"></a><span class="lineno">  720</span><span class="comment">   *     // Since we asked for S_PEER_SOCKET_READABLE, we know results are all Peer_sockets.  Cast to that type:</span></div>
<div class="line"><a id="l00721" name="l00721"></a><span class="lineno">  721</span><span class="comment">   *     const Peer_socket::Ptr readable_sock = boost::any_cast&lt;Peer_socket::Ptr&gt;(readable_sock_as_any);</span></div>
<div class="line"><a id="l00722" name="l00722"></a><span class="lineno">  722</span><span class="comment">   *     // PEER_SOCKET_READABLE indicates readiness to receive() to yield data or an error.  We can now do so!</span></div>
<div class="line"><a id="l00723" name="l00723"></a><span class="lineno">  723</span><span class="comment">   *     readable_sock-&gt;receive(...); // Details of this call left to reader.</span></div>
<div class="line"><a id="l00724" name="l00724"></a><span class="lineno">  724</span><span class="comment">   *   }</span></div>
<div class="line"><a id="l00725" name="l00725"></a><span class="lineno">  725</span><span class="comment">   *   ~~~</span></div>
<div class="line"><a id="l00726" name="l00726"></a><span class="lineno">  726</span><span class="comment">   *</span></div>
<div class="line"><a id="l00727" name="l00727"></a><span class="lineno">  727</span><span class="comment">   * @param target_set</span></div>
<div class="line"><a id="l00728" name="l00728"></a><span class="lineno">  728</span><span class="comment">   *        Pointer to set of sockets to which to load the current internal set of result sockets</span></div>
<div class="line"><a id="l00729" name="l00729"></a><span class="lineno">  729</span><span class="comment">   *        of type `ev_type` found during the last wait.  Any elements here at call time will be removed.</span></div>
<div class="line"><a id="l00730" name="l00730"></a><span class="lineno">  730</span><span class="comment">   * @param ev_type</span></div>
<div class="line"><a id="l00731" name="l00731"></a><span class="lineno">  731</span><span class="comment">   *        The condition we are interested in which sockets have reached during the last wait.</span></div>
<div class="line"><a id="l00732" name="l00732"></a><span class="lineno">  732</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00733" name="l00733"></a><span class="lineno">  733</span><span class="comment">   *        See flow::Error_code docs for error reporting semantics.  Generated codes:</span></div>
<div class="line"><a id="l00734" name="l00734"></a><span class="lineno">  734</span><span class="comment">   *        error::Code::S_EVENT_SET_CLOSED, error::Code::S_EVENT_SET_IMMUTABLE_WHEN_WAITING.</span></div>
<div class="line"><a id="l00735" name="l00735"></a><span class="lineno">  735</span><span class="comment">   * @return `true` if and only if no error occurred (`*err_code` is success).</span></div>
<div class="line"><a id="l00736" name="l00736"></a><span class="lineno">  736</span><span class="comment">   *</span></div>
<div class="line"><a id="l00737" name="l00737"></a><span class="lineno">  737</span><span class="comment">   * @todo Event_set::emit_result_sockets() sets a #Sockets structure which stores `boost:any`s each of which</span></div>
<div class="line"><a id="l00738" name="l00738"></a><span class="lineno">  738</span><span class="comment">   *       stores either a `Peer_socket::Ptr` or a `Server_socket::Ptr`; #Sockets should be changed to store</span></div>
<div class="line"><a id="l00739" name="l00739"></a><span class="lineno">  739</span><span class="comment">   *       C++17 `std::variant`s.  Performance, both internally and externally, would improve by using this</span></div>
<div class="line"><a id="l00740" name="l00740"></a><span class="lineno">  740</span><span class="comment">   *       type-safe compile-time mechanism (which is akin to `union`s but much more pleasant to use).</span></div>
<div class="line"><a id="l00741" name="l00741"></a><span class="lineno">  741</span><span class="comment">   *       At the time this feature was written, Flow was in C++11, so `variant`s were not available, and</span></div>
<div class="line"><a id="l00742" name="l00742"></a><span class="lineno">  742</span><span class="comment">   *       the author wanted to play around with `any`s instead of haxoring old-school `union`s.</span></div>
<div class="line"><a id="l00743" name="l00743"></a><span class="lineno">  743</span><span class="comment">   *       `variant` is much nicer, however, and the dynamic nature of `any` is entirely unnecessary here.</span></div>
<div class="line"><a id="l00744" name="l00744"></a><span class="lineno">  744</span><span class="comment">   */</span></div>
<div class="line"><a id="l00745" name="l00745"></a><span class="lineno">  745</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Event__set.html#a72b26f25a2e76e3c61b4760b59de5b25">emit_result_sockets</a>(<a class="code hl_class" href="classflow_1_1util_1_1Linked__hash__set.html">Sockets</a>* target_set, <a class="code hl_enumeration" href="classflow_1_1net__flow_1_1Event__set.html#a19cc3a286c8a11c986d2a59ec1e39a71">Event_type</a> ev_type, <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00746" name="l00746"></a><span class="lineno">  746</span><span class="comment"></span> </div>
<div class="line"><a id="l00747" name="l00747"></a><span class="lineno">  747</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00748" name="l00748"></a><span class="lineno">  748</span><span class="comment">   * Identical to `emit_result_sockets(&amp;sockets, ev_type, err_code)`, where originally `sockets` is empty and</span></div>
<div class="line"><a id="l00749" name="l00749"></a><span class="lineno">  749</span><span class="comment">   * is afterwards cleared; but more efficient.</span></div>
<div class="line"><a id="l00750" name="l00750"></a><span class="lineno">  750</span><span class="comment">   *</span></div>
<div class="line"><a id="l00751" name="l00751"></a><span class="lineno">  751</span><span class="comment">   * @param ev_type</span></div>
<div class="line"><a id="l00752" name="l00752"></a><span class="lineno">  752</span><span class="comment">   *        See emit_result_sockets().</span></div>
<div class="line"><a id="l00753" name="l00753"></a><span class="lineno">  753</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00754" name="l00754"></a><span class="lineno">  754</span><span class="comment">   *        Same.</span></div>
<div class="line"><a id="l00755" name="l00755"></a><span class="lineno">  755</span><span class="comment">   * @return Same.</span></div>
<div class="line"><a id="l00756" name="l00756"></a><span class="lineno">  756</span><span class="comment">   */</span></div>
<div class="line"><a id="l00757" name="l00757"></a><span class="lineno">  757</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Event__set.html#afb6379c7fe127c26fd4cdc9752ccf9e2">clear_result_sockets</a>(<a class="code hl_enumeration" href="classflow_1_1net__flow_1_1Event__set.html#a19cc3a286c8a11c986d2a59ec1e39a71">Event_type</a> ev_type, <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00758" name="l00758"></a><span class="lineno">  758</span><span class="comment"></span> </div>
<div class="line"><a id="l00759" name="l00759"></a><span class="lineno">  759</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00760" name="l00760"></a><span class="lineno">  760</span><span class="comment">   * Forgets all sockets stored in this object in any fashion.</span></div>
<div class="line"><a id="l00761" name="l00761"></a><span class="lineno">  761</span><span class="comment">   *</span></div>
<div class="line"><a id="l00762" name="l00762"></a><span class="lineno">  762</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00763" name="l00763"></a><span class="lineno">  763</span><span class="comment">   *        See flow::Error_code docs for error reporting semantics.  Generated codes:</span></div>
<div class="line"><a id="l00764" name="l00764"></a><span class="lineno">  764</span><span class="comment">   *        error::Code::S_EVENT_SET_CLOSED, error::Code::S_EVENT_SET_IMMUTABLE_WHEN_WAITING.</span></div>
<div class="line"><a id="l00765" name="l00765"></a><span class="lineno">  765</span><span class="comment">   * @return true if and only if no error occurred (*err_code is success).</span></div>
<div class="line"><a id="l00766" name="l00766"></a><span class="lineno">  766</span><span class="comment">   */</span></div>
<div class="line"><a id="l00767" name="l00767"></a><span class="lineno">  767</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Event__set.html#ab64e128595b701e37256ff79d782c146">clear</a>(<a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code = 0);</div>
<div class="line"><a id="l00768" name="l00768"></a><span class="lineno">  768</span> </div>
<div class="line"><a id="l00769" name="l00769"></a><span class="lineno">  769</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00770" name="l00770"></a><span class="lineno">  770</span>  <span class="comment">// Friends.</span></div>
<div class="line"><a id="l00771" name="l00771"></a><span class="lineno">  771</span><span class="comment"></span> </div>
<div class="line"><a id="l00772" name="l00772"></a><span class="lineno">  772</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00773" name="l00773"></a><span class="lineno">  773</span><span class="comment">   * See rationale for `friend`ing Node in class Event_set documentation header.</span></div>
<div class="line"><a id="l00774" name="l00774"></a><span class="lineno">  774</span><span class="comment">   * @see Node.</span></div>
<div class="line"><a id="l00775" name="l00775"></a><span class="lineno">  775</span><span class="comment">   */</span></div>
<div class="line"><a id="l00776" name="l00776"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Event__set.html#a6db9d28bd448a131448276ee03de1e6d">  776</a></span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code hl_class" href="classflow_1_1net__flow_1_1Node.html">Node</a>;</div>
<div class="line"><a id="l00777" name="l00777"></a><span class="lineno">  777</span> </div>
<div class="line"><a id="l00778" name="l00778"></a><span class="lineno">  778</span>  <span class="comment">// Types.</span></div>
<div class="line"><a id="l00779" name="l00779"></a><span class="lineno">  779</span><span class="comment"></span> </div>
<div class="line"><a id="l00780" name="l00780"></a><span class="lineno">  780</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00781" name="l00781"></a><span class="lineno">  781</span><span class="comment">   * Short-hand for reentrant mutex type.  We explicitly rely on reentrant behavior, so this isn&#39;t &quot;just in case.&quot;</span></div>
<div class="line"><a id="l00782" name="l00782"></a><span class="lineno">  782</span><span class="comment">   * (One shouldn&#39;t use reentrant mutexes &quot;just in case&quot;; it should be entirely conscious and on-purpose; one should</span></div>
<div class="line"><a id="l00783" name="l00783"></a><span class="lineno">  783</span><span class="comment">   * use non-reentrant mutexes, all else being equal.)</span></div>
<div class="line"><a id="l00784" name="l00784"></a><span class="lineno">  784</span><span class="comment">   *</span></div>
<div class="line"><a id="l00785" name="l00785"></a><span class="lineno">  785</span><span class="comment">   * @todo This doc header for Event_set::Mutex should specify what specific behavior requires mutex reentrance, so that</span></div>
<div class="line"><a id="l00786" name="l00786"></a><span class="lineno">  786</span><span class="comment">   * for example one could reevaluate whether there&#39;s a sleeker code pattern that would avoid it.</span></div>
<div class="line"><a id="l00787" name="l00787"></a><span class="lineno">  787</span><span class="comment">   */</span></div>
<div class="line"><a id="l00788" name="l00788"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Event__set.html#a47e4e6d304a6a381e7469fe87c547738">  788</a></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classflow_1_1net__flow_1_1Event__set.html#a47e4e6d304a6a381e7469fe87c547738">Mutex</a> = <a class="code hl_typedef" href="namespaceflow_1_1util.html#a9c7a5df07c2e86c788de9e6bbaee77d5">util::Mutex_recursive</a>;</div>
<div class="line"><a id="l00789" name="l00789"></a><span class="lineno">  789</span><span class="comment"></span> </div>
<div class="line"><a id="l00790" name="l00790"></a><span class="lineno">  790</span><span class="comment">  /// Short-hand for RAII lock guard of #Mutex.  Use instead of `boost::lock_guard` for `release()` at least.</span></div>
<div class="line"><a id="l00791" name="l00791"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Event__set.html#a7e6ff0e1ad4c13220a371045101a5eff">  791</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classflow_1_1net__flow_1_1Event__set.html#a7e6ff0e1ad4c13220a371045101a5eff">Lock_guard</a> = <a class="code hl_typedef" href="namespaceflow_1_1util.html#a5d2247b715da63e4b960909561b90ae7">util::Lock_guard&lt;Mutex&gt;</a>;</div>
<div class="line"><a id="l00792" name="l00792"></a><span class="lineno">  792</span><span class="comment"></span> </div>
<div class="line"><a id="l00793" name="l00793"></a><span class="lineno">  793</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00794" name="l00794"></a><span class="lineno">  794</span><span class="comment">   * Short-hand for type storing a set of socket sets -- one per possible #Event_type `enum` value.</span></div>
<div class="line"><a id="l00795" name="l00795"></a><span class="lineno">  795</span><span class="comment">   * In practice, the key set for a value of this type is all Event_type members; use</span></div>
<div class="line"><a id="l00796" name="l00796"></a><span class="lineno">  796</span><span class="comment">   * empty_ev_type_to_socks_map() to create a maximally empty such structure.</span></div>
<div class="line"><a id="l00797" name="l00797"></a><span class="lineno">  797</span><span class="comment">   */</span></div>
<div class="line"><a id="l00798" name="l00798"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Event__set.html#affac46b4e327b3781faab4853a290877">  798</a></span>  <span class="keyword">using </span><a class="code hl_class" href="classflow_1_1util_1_1Linked__hash__map.html">Ev_type_to_socks_map</a> = <a class="code hl_class" href="classflow_1_1util_1_1Linked__hash__map.html">util::Linked_hash_map&lt;Event_type, Sockets&gt;</a>;</div>
<div class="line"><a id="l00799" name="l00799"></a><span class="lineno">  799</span> </div>
<div class="line"><a id="l00800" name="l00800"></a><span class="lineno">  800</span>  <span class="comment">// Constructors.</span></div>
<div class="line"><a id="l00801" name="l00801"></a><span class="lineno">  801</span><span class="comment"></span> </div>
<div class="line"><a id="l00802" name="l00802"></a><span class="lineno">  802</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00803" name="l00803"></a><span class="lineno">  803</span><span class="comment">   * Constructs object; initializes all values to well-defined but possibly meaningless values (0,</span></div>
<div class="line"><a id="l00804" name="l00804"></a><span class="lineno">  804</span><span class="comment">   * empty, etc.).</span></div>
<div class="line"><a id="l00805" name="l00805"></a><span class="lineno">  805</span><span class="comment">   *</span></div>
<div class="line"><a id="l00806" name="l00806"></a><span class="lineno">  806</span><span class="comment">   * @param logger_ptr</span></div>
<div class="line"><a id="l00807" name="l00807"></a><span class="lineno">  807</span><span class="comment">   *        The Logger implementation to use subsequently.</span></div>
<div class="line"><a id="l00808" name="l00808"></a><span class="lineno">  808</span><span class="comment">   */</span></div>
<div class="line"><a id="l00809" name="l00809"></a><span class="lineno">  809</span>  <span class="keyword">explicit</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Event__set.html#a7b8e6cf7046b6905015301a203cd88f5">Event_set</a>(<a class="code hl_class" href="classflow_1_1log_1_1Logger.html">log::Logger</a>* logger_ptr);</div>
<div class="line"><a id="l00810" name="l00810"></a><span class="lineno">  810</span> </div>
<div class="line"><a id="l00811" name="l00811"></a><span class="lineno">  811</span>  <span class="comment">// Methods.</span></div>
<div class="line"><a id="l00812" name="l00812"></a><span class="lineno">  812</span><span class="comment"></span> </div>
<div class="line"><a id="l00813" name="l00813"></a><span class="lineno">  813</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00814" name="l00814"></a><span class="lineno">  814</span><span class="comment">   * Helper that ensures the state of `*this` is such that one may modify the #m_can and #m_want</span></div>
<div class="line"><a id="l00815" name="l00815"></a><span class="lineno">  815</span><span class="comment">   * socket sets.  Pre-condition: #m_mutex is locked.</span></div>
<div class="line"><a id="l00816" name="l00816"></a><span class="lineno">  816</span><span class="comment">   *</span></div>
<div class="line"><a id="l00817" name="l00817"></a><span class="lineno">  817</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00818" name="l00818"></a><span class="lineno">  818</span><span class="comment">   *        If `false` returned, sets this to the reason why socket sets are not OK to modify.</span></div>
<div class="line"><a id="l00819" name="l00819"></a><span class="lineno">  819</span><span class="comment">   *        Otherwise sets it to success.  Possible errors:</span></div>
<div class="line"><a id="l00820" name="l00820"></a><span class="lineno">  820</span><span class="comment">   *        error::Code::S_EVENT_SET_CLOSED, error::Code::S_EVENT_SET_IMMUTABLE_WHEN_WAITING.</span></div>
<div class="line"><a id="l00821" name="l00821"></a><span class="lineno">  821</span><span class="comment">   * @return `true` if OK to modify; `false` if not OK to modify.</span></div>
<div class="line"><a id="l00822" name="l00822"></a><span class="lineno">  822</span><span class="comment">   */</span></div>
<div class="line"><a id="l00823" name="l00823"></a><span class="lineno">  823</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Event__set.html#a8e16d91f81860eb2a6c971863548e466">ok_to_mod_socket_set</a>(<a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00824" name="l00824"></a><span class="lineno">  824</span><span class="comment"></span> </div>
<div class="line"><a id="l00825" name="l00825"></a><span class="lineno">  825</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00826" name="l00826"></a><span class="lineno">  826</span><span class="comment">   * Same as the public `sync_wait(max_wait)` but uses a `Fine_clock`-based `Fine_duration` non-template</span></div>
<div class="line"><a id="l00827" name="l00827"></a><span class="lineno">  827</span><span class="comment">   * type for implementation convenience and to avoid code bloat in specifying timeout.</span></div>
<div class="line"><a id="l00828" name="l00828"></a><span class="lineno">  828</span><span class="comment">   *</span></div>
<div class="line"><a id="l00829" name="l00829"></a><span class="lineno">  829</span><span class="comment">   * @param max_wait</span></div>
<div class="line"><a id="l00830" name="l00830"></a><span class="lineno">  830</span><span class="comment">   *        See the public sync_wait() *with* a `max_wait` argument.  `&quot;duration&lt;Rep, Period&gt;::max()&quot;` maps to the value</span></div>
<div class="line"><a id="l00831" name="l00831"></a><span class="lineno">  831</span><span class="comment">   *        `Fine_duration::max()` for this argument.</span></div>
<div class="line"><a id="l00832" name="l00832"></a><span class="lineno">  832</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00833" name="l00833"></a><span class="lineno">  833</span><span class="comment">   *        See sync_wait().</span></div>
<div class="line"><a id="l00834" name="l00834"></a><span class="lineno">  834</span><span class="comment">   * @return See sync_wait().</span></div>
<div class="line"><a id="l00835" name="l00835"></a><span class="lineno">  835</span><span class="comment">   */</span></div>
<div class="line"><a id="l00836" name="l00836"></a><span class="lineno">  836</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Event__set.html#a13a17c404f0ce43da5fec53a550da9be">sync_wait_impl</a>(<span class="keyword">const</span> <a class="code hl_typedef" href="namespaceflow.html#a48799f1263cdeedec125be51a3db2b79">Fine_duration</a>&amp; max_wait, <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code);</div>
<div class="line"><a id="l00837" name="l00837"></a><span class="lineno">  837</span><span class="comment"></span> </div>
<div class="line"><a id="l00838" name="l00838"></a><span class="lineno">  838</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00839" name="l00839"></a><span class="lineno">  839</span><span class="comment">   * Creates a maximally empty #Ev_type_to_socks_map: it will have all possible Event_type as keys</span></div>
<div class="line"><a id="l00840" name="l00840"></a><span class="lineno">  840</span><span class="comment">   * but only empty #Sockets sets as values.</span></div>
<div class="line"><a id="l00841" name="l00841"></a><span class="lineno">  841</span><span class="comment">   *</span></div>
<div class="line"><a id="l00842" name="l00842"></a><span class="lineno">  842</span><span class="comment">   * @return Ditto.</span></div>
<div class="line"><a id="l00843" name="l00843"></a><span class="lineno">  843</span><span class="comment">   */</span></div>
<div class="line"><a id="l00844" name="l00844"></a><span class="lineno">  844</span>  <span class="keyword">static</span> <a class="code hl_class" href="classflow_1_1util_1_1Linked__hash__map.html">Ev_type_to_socks_map</a> <a class="code hl_function" href="classflow_1_1net__flow_1_1Event__set.html#a79d75ea514f571d9f6bd2cfcad502f22">empty_ev_type_to_socks_map</a>();</div>
<div class="line"><a id="l00845" name="l00845"></a><span class="lineno">  845</span><span class="comment"></span> </div>
<div class="line"><a id="l00846" name="l00846"></a><span class="lineno">  846</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00847" name="l00847"></a><span class="lineno">  847</span><span class="comment">   * Helper that clears each #Sockets set inside an #Ev_type_to_socks_map.  Thus,</span></div>
<div class="line"><a id="l00848" name="l00848"></a><span class="lineno">  848</span><span class="comment">   * it is equivalent to `*ev_type_to_socks_map = empty_ev_type_to_socks_map()`, but perhaps faster.</span></div>
<div class="line"><a id="l00849" name="l00849"></a><span class="lineno">  849</span><span class="comment">   *</span></div>
<div class="line"><a id="l00850" name="l00850"></a><span class="lineno">  850</span><span class="comment">   * @param ev_type_to_socks_map</span></div>
<div class="line"><a id="l00851" name="l00851"></a><span class="lineno">  851</span><span class="comment">   *        Target map.</span></div>
<div class="line"><a id="l00852" name="l00852"></a><span class="lineno">  852</span><span class="comment">   */</span></div>
<div class="line"><a id="l00853" name="l00853"></a><span class="lineno">  853</span>  <span class="keyword">static</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Event__set.html#a0edced1cb69b2cad299ee32e652ccea7">clear_ev_type_to_socks_map</a>(<a class="code hl_class" href="classflow_1_1util_1_1Linked__hash__map.html">Ev_type_to_socks_map</a>* ev_type_to_socks_map);</div>
<div class="line"><a id="l00854" name="l00854"></a><span class="lineno">  854</span><span class="comment"></span> </div>
<div class="line"><a id="l00855" name="l00855"></a><span class="lineno">  855</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00856" name="l00856"></a><span class="lineno">  856</span><span class="comment">   * Functional helper that checks whether a given `pair` in an #Ev_type_to_socks_map contains an empty</span></div>
<div class="line"><a id="l00857" name="l00857"></a><span class="lineno">  857</span><span class="comment">   * set of #Sockets or not.</span></div>
<div class="line"><a id="l00858" name="l00858"></a><span class="lineno">  858</span><span class="comment">   *</span></div>
<div class="line"><a id="l00859" name="l00859"></a><span class="lineno">  859</span><span class="comment">   * @param ev_type_and_socks</span></div>
<div class="line"><a id="l00860" name="l00860"></a><span class="lineno">  860</span><span class="comment">   *        A value (key and mapped, not just mapped) from an #Ev_type_to_socks_map.</span></div>
<div class="line"><a id="l00861" name="l00861"></a><span class="lineno">  861</span><span class="comment">   * @return `true` if and only if the socket set is empty.</span></div>
<div class="line"><a id="l00862" name="l00862"></a><span class="lineno">  862</span><span class="comment">   */</span></div>
<div class="line"><a id="l00863" name="l00863"></a><span class="lineno">  863</span>  <span class="keyword">static</span> <span class="keywordtype">bool</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Event__set.html#aed9505b886c78169fe35b527f4e01855">ev_type_to_socks_map_entry_is_empty</a>(<span class="keyword">const</span> <a class="code hl_typedef" href="classflow_1_1util_1_1Linked__hash__map.html#af8b3b1128da79536a4c86e9feadb0c66">Ev_type_to_socks_map::Value</a>&amp; ev_type_and_socks);</div>
<div class="line"><a id="l00864" name="l00864"></a><span class="lineno">  864</span><span class="comment"></span> </div>
<div class="line"><a id="l00865" name="l00865"></a><span class="lineno">  865</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00866" name="l00866"></a><span class="lineno">  866</span><span class="comment">   * Helper that returns a loggable string summarizing the sizes of the socket sets, by type, stored in</span></div>
<div class="line"><a id="l00867" name="l00867"></a><span class="lineno">  867</span><span class="comment">   * an #Ev_type_to_socks_map.</span></div>
<div class="line"><a id="l00868" name="l00868"></a><span class="lineno">  868</span><span class="comment">   *</span></div>
<div class="line"><a id="l00869" name="l00869"></a><span class="lineno">  869</span><span class="comment">   * @param ev_type_to_socks_map</span></div>
<div class="line"><a id="l00870" name="l00870"></a><span class="lineno">  870</span><span class="comment">   *        A valid such map.</span></div>
<div class="line"><a id="l00871" name="l00871"></a><span class="lineno">  871</span><span class="comment">   * @return Loggable string.</span></div>
<div class="line"><a id="l00872" name="l00872"></a><span class="lineno">  872</span><span class="comment">   */</span></div>
<div class="line"><a id="l00873" name="l00873"></a><span class="lineno">  873</span>  <span class="keyword">static</span> std::string <a class="code hl_function" href="classflow_1_1net__flow_1_1Event__set.html#a19e241ae4dfe1ea54de6027052bc2135">ev_type_to_socks_map_sizes_to_str</a>(<span class="keyword">const</span> <a class="code hl_class" href="classflow_1_1util_1_1Linked__hash__map.html">Ev_type_to_socks_map</a>&amp; ev_type_to_socks_map);</div>
<div class="line"><a id="l00874" name="l00874"></a><span class="lineno">  874</span><span class="comment"></span> </div>
<div class="line"><a id="l00875" name="l00875"></a><span class="lineno">  875</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00876" name="l00876"></a><span class="lineno">  876</span><span class="comment">   * Helper that returns a loggable string representing the socket stored in the given `boost::any` that</span></div>
<div class="line"><a id="l00877" name="l00877"></a><span class="lineno">  877</span><span class="comment">   * stores a value allowed by the members of #Event_type `enum`.</span></div>
<div class="line"><a id="l00878" name="l00878"></a><span class="lineno">  878</span><span class="comment">   *</span></div>
<div class="line"><a id="l00879" name="l00879"></a><span class="lineno">  879</span><span class="comment">   * @param sock_as_any</span></div>
<div class="line"><a id="l00880" name="l00880"></a><span class="lineno">  880</span><span class="comment">   *        See above.  `sock_as_any.empty()` is also allowed.</span></div>
<div class="line"><a id="l00881" name="l00881"></a><span class="lineno">  881</span><span class="comment">   * @return Loggable string.</span></div>
<div class="line"><a id="l00882" name="l00882"></a><span class="lineno">  882</span><span class="comment">   */</span></div>
<div class="line"><a id="l00883" name="l00883"></a><span class="lineno">  883</span>  <span class="keyword">static</span> std::string <a class="code hl_function" href="classflow_1_1net__flow_1_1Event__set.html#ae04c117b15179ba37a94f6836c63497b">sock_as_any_to_str</a>(<span class="keyword">const</span> boost::any&amp; sock_as_any);</div>
<div class="line"><a id="l00884" name="l00884"></a><span class="lineno">  884</span> </div>
<div class="line"><a id="l00885" name="l00885"></a><span class="lineno">  885</span>  <span class="comment">// Constants.</span></div>
<div class="line"><a id="l00886" name="l00886"></a><span class="lineno">  886</span><span class="comment"></span> </div>
<div class="line"><a id="l00887" name="l00887"></a><span class="lineno">  887</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00888" name="l00888"></a><span class="lineno">  888</span><span class="comment">   * Mapping from each possible #Event_type to the Node method that determines whether the condition defined by</span></div>
<div class="line"><a id="l00889" name="l00889"></a><span class="lineno">  889</span><span class="comment">   * that #Event_type is currently true for the socket wrapped in the `boost::any` argument passed to the method.</span></div>
<div class="line"><a id="l00890" name="l00890"></a><span class="lineno">  890</span><span class="comment">   *</span></div>
<div class="line"><a id="l00891" name="l00891"></a><span class="lineno">  891</span><span class="comment">   * E.g., `bool Node::sock_is_readable(const boost::any sock_as_any) const` is to return true if and only if</span></div>
<div class="line"><a id="l00892" name="l00892"></a><span class="lineno">  892</span><span class="comment">   * `sock = boost::any_cast&lt;Peer_socket::Ptr&gt;(sock_as_any)` -- which is a Peer_socket::Ptr -- would yield non-zero</span></div>
<div class="line"><a id="l00893" name="l00893"></a><span class="lineno">  893</span><span class="comment">   * or zero and error if one were to execute `sock-&gt;receive()`.  Note that the latter condition is defined by the</span></div>
<div class="line"><a id="l00894" name="l00894"></a><span class="lineno">  894</span><span class="comment">   * doc comment on Event_type::S_PEER_SOCKET_READABLE.</span></div>
<div class="line"><a id="l00895" name="l00895"></a><span class="lineno">  895</span><span class="comment">   */</span></div>
<div class="line"><a id="l00896" name="l00896"></a><span class="lineno">  896</span>  <span class="keyword">static</span> <span class="keyword">const</span> boost::unordered_map&lt;<a class="code hl_enumeration" href="classflow_1_1net__flow_1_1Event__set.html#a19cc3a286c8a11c986d2a59ec1e39a71">Event_type</a>, <a class="code hl_class" href="classflow_1_1Function.html">Function</a>&lt;<a class="code hl_class" href="classbool.html">bool</a> (<span class="keyword">const</span> <a class="code hl_class" href="classflow_1_1net__flow_1_1Node.html">Node</a>*, <span class="keyword">const</span> boost::any&amp;)&gt;&gt;</div>
<div class="line"><a id="l00897" name="l00897"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Event__set.html#aa321c69146b8575e4d0e3b15c67d4f08">  897</a></span>                 <a class="code hl_variable" href="classflow_1_1net__flow_1_1Event__set.html#aa321c69146b8575e4d0e3b15c67d4f08">S_EV_TYPE_TO_IS_ACTIVE_NODE_MTD</a>;</div>
<div class="line"><a id="l00898" name="l00898"></a><span class="lineno">  898</span>  <span class="comment">// Data.</span></div>
<div class="line"><a id="l00899" name="l00899"></a><span class="lineno">  899</span><span class="comment"></span> </div>
<div class="line"><a id="l00900" name="l00900"></a><span class="lineno">  900</span><span class="comment">  /// See state().  Should be set before user gets access to `*this`.  Must not be modified by non-W threads after that.</span></div>
<div class="line"><a id="l00901" name="l00901"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Event__set.html#a56925e15b38d285f387e10bfb18f93c9">  901</a></span><span class="comment"></span>  <a class="code hl_enumeration" href="classflow_1_1net__flow_1_1Event__set.html#a2855bd159b6e63bf448ed1f41b608975">State</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Event__set.html#a56925e15b38d285f387e10bfb18f93c9">m_state</a>;</div>
<div class="line"><a id="l00902" name="l00902"></a><span class="lineno">  902</span><span class="comment"></span> </div>
<div class="line"><a id="l00903" name="l00903"></a><span class="lineno">  903</span><span class="comment">  /// See node().  Should be set before user gets access to `*this`.  Must not be modified by non-W threads after that.</span></div>
<div class="line"><a id="l00904" name="l00904"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Event__set.html#af635301685a4a331142e1ac8a791a65d">  904</a></span><span class="comment"></span>  <a class="code hl_class" href="classflow_1_1net__flow_1_1Node.html">Node</a>* <a class="code hl_variable" href="classflow_1_1net__flow_1_1Event__set.html#af635301685a4a331142e1ac8a791a65d">m_node</a>;</div>
<div class="line"><a id="l00905" name="l00905"></a><span class="lineno">  905</span><span class="comment"></span> </div>
<div class="line"><a id="l00906" name="l00906"></a><span class="lineno">  906</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00907" name="l00907"></a><span class="lineno">  907</span><span class="comment">   * The sockets, categorized by #Event_type of interest, to check for &quot;ready&quot; status (as defined in the doc header</span></div>
<div class="line"><a id="l00908" name="l00908"></a><span class="lineno">  908</span><span class="comment">   * for each #Event_type), in the next wait (State::S_WAITING state).</span></div>
<div class="line"><a id="l00909" name="l00909"></a><span class="lineno">  909</span><span class="comment">   */</span></div>
<div class="line"><a id="l00910" name="l00910"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Event__set.html#af4fa5dbda4ffd95b35dee57fc01b90ce">  910</a></span>  <a class="code hl_class" href="classflow_1_1util_1_1Linked__hash__map.html">Ev_type_to_socks_map</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Event__set.html#af4fa5dbda4ffd95b35dee57fc01b90ce">m_want</a>;</div>
<div class="line"><a id="l00911" name="l00911"></a><span class="lineno">  911</span><span class="comment"></span> </div>
<div class="line"><a id="l00912" name="l00912"></a><span class="lineno">  912</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00913" name="l00913"></a><span class="lineno">  913</span><span class="comment">   * The sockets, categorized by #Event_type of interest, that were found to be &quot;ready&quot; (as defined in the doc header</span></div>
<div class="line"><a id="l00914" name="l00914"></a><span class="lineno">  914</span><span class="comment">   * for each #Event_type), during the last wait (State::S_WAITING state).  For each WAITING period, each set in</span></div>
<div class="line"><a id="l00915" name="l00915"></a><span class="lineno">  915</span><span class="comment">   * #m_can following that period must be a subset of the corresponding #m_want set when entering that period.</span></div>
<div class="line"><a id="l00916" name="l00916"></a><span class="lineno">  916</span><span class="comment">   *</span></div>
<div class="line"><a id="l00917" name="l00917"></a><span class="lineno">  917</span><span class="comment">   * E.g., `m_can[S_PEER_SOCKET_READABLE]` after WAITING is a subset of `m_want[S_PEER_SOCKET_READABLE]` when just</span></div>
<div class="line"><a id="l00918" name="l00918"></a><span class="lineno">  918</span><span class="comment">   * starting WAITING.</span></div>
<div class="line"><a id="l00919" name="l00919"></a><span class="lineno">  919</span><span class="comment">   */</span></div>
<div class="line"><a id="l00920" name="l00920"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Event__set.html#abf8a102c621b1536659973b2d6b33822">  920</a></span>  <a class="code hl_class" href="classflow_1_1util_1_1Linked__hash__map.html">Ev_type_to_socks_map</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Event__set.html#abf8a102c621b1536659973b2d6b33822">m_can</a>;</div>
<div class="line"><a id="l00921" name="l00921"></a><span class="lineno">  921</span><span class="comment"></span> </div>
<div class="line"><a id="l00922" name="l00922"></a><span class="lineno">  922</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00923" name="l00923"></a><span class="lineno">  923</span><span class="comment">   * During State::S_WAITING, stores the handler (a `void` function with 1 `bool` argument) that will be</span></div>
<div class="line"><a id="l00924" name="l00924"></a><span class="lineno">  924</span><span class="comment">   * called once one or more events are found to hold.  `m_on_event.empty()` at all other times.</span></div>
<div class="line"><a id="l00925" name="l00925"></a><span class="lineno">  925</span><span class="comment">   */</span></div>
<div class="line"><a id="l00926" name="l00926"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Event__set.html#a59f6ddb0d0258cc029c435a8ed0f89f7">  926</a></span>  <a class="code hl_class" href="classflow_1_1Function.html">Event_handler</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Event__set.html#a59f6ddb0d0258cc029c435a8ed0f89f7">m_on_event</a>;</div>
<div class="line"><a id="l00927" name="l00927"></a><span class="lineno">  927</span><span class="comment"></span> </div>
<div class="line"><a id="l00928" name="l00928"></a><span class="lineno">  928</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00929" name="l00929"></a><span class="lineno">  929</span><span class="comment">   * While in State::S_WAITING, if this is `true`, an exhaustive check of all desired events is yet to</span></div>
<div class="line"><a id="l00930" name="l00930"></a><span class="lineno">  930</span><span class="comment">   * be performed (in thread W); if `false`, it has alredy been performed (in thread W), and only</span></div>
<div class="line"><a id="l00931" name="l00931"></a><span class="lineno">  931</span><span class="comment">   * &quot;delta&quot; checks need to be checked from now on during this wait.  See details in giant comment</span></div>
<div class="line"><a id="l00932" name="l00932"></a><span class="lineno">  932</span><span class="comment">   * block inside async_wait().</span></div>
<div class="line"><a id="l00933" name="l00933"></a><span class="lineno">  933</span><span class="comment">   */</span></div>
<div class="line"><a id="l00934" name="l00934"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Event__set.html#ada8d103341b6450f3390dc6ce24ccdef">  934</a></span>  <span class="keywordtype">bool</span> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Event__set.html#ada8d103341b6450f3390dc6ce24ccdef">m_baseline_check_pending</a>;</div>
<div class="line"><a id="l00935" name="l00935"></a><span class="lineno">  935</span><span class="comment"></span> </div>
<div class="line"><a id="l00936" name="l00936"></a><span class="lineno">  936</span><span class="comment">  /// Mutex protecting ALL data in this object.</span></div>
<div class="line"><a id="l00937" name="l00937"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Event__set.html#a0dda853ab017dd9bfcfb71b601d15698">  937</a></span><span class="comment"></span>  <span class="keyword">mutable</span> <a class="code hl_typedef" href="classflow_1_1net__flow_1_1Event__set.html#a47e4e6d304a6a381e7469fe87c547738">Mutex</a> <a class="code hl_variable" href="classflow_1_1net__flow_1_1Event__set.html#a0dda853ab017dd9bfcfb71b601d15698">m_mutex</a>;</div>
<div class="line"><a id="l00938" name="l00938"></a><span class="lineno">  938</span>}; <span class="comment">// class Event_set</span></div>
<div class="line"><a id="l00939" name="l00939"></a><span class="lineno">  939</span><span class="comment"></span> </div>
<div class="line"><a id="l00940" name="l00940"></a><span class="lineno">  940</span><span class="comment">/**</span></div>
<div class="line"><a id="l00941" name="l00941"></a><span class="lineno">  941</span><span class="comment"> * Hasher class used in storing various sockets of types wrapped as `boost::any`s in the #Sockets type.</span></div>
<div class="line"><a id="l00942" name="l00942"></a><span class="lineno">  942</span><span class="comment"> * We do not simply define `hash_value(any)`, because our implementation specifically works for `any` objects</span></div>
<div class="line"><a id="l00943" name="l00943"></a><span class="lineno">  943</span><span class="comment"> * that store various sockets and won&#39;t work for all other possibilities; and we don&#39;t want to force this</span></div>
<div class="line"><a id="l00944" name="l00944"></a><span class="lineno">  944</span><span class="comment"> * on every user of `hash&lt;any&gt;`.</span></div>
<div class="line"><a id="l00945" name="l00945"></a><span class="lineno">  945</span><span class="comment"> */</span></div>
<div class="line"><a id="l00946" name="l00946"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Event__set_1_1Socket__as__any__hash.html">  946</a></span><span class="keyword">class </span><a class="code hl_class" href="classflow_1_1net__flow_1_1Event__set_1_1Socket__as__any__hash.html">Event_set::Socket_as_any_hash</a></div>
<div class="line"><a id="l00947" name="l00947"></a><span class="lineno">  947</span>{</div>
<div class="line"><a id="l00948" name="l00948"></a><span class="lineno">  948</span><span class="keyword">public</span>:<span class="comment"></span></div>
<div class="line"><a id="l00949" name="l00949"></a><span class="lineno">  949</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00950" name="l00950"></a><span class="lineno">  950</span><span class="comment">   * Returns hash value of the given object which must be stored in a #Sockets object.</span></div>
<div class="line"><a id="l00951" name="l00951"></a><span class="lineno">  951</span><span class="comment">   *</span></div>
<div class="line"><a id="l00952" name="l00952"></a><span class="lineno">  952</span><span class="comment">   * @param sock_as_any</span></div>
<div class="line"><a id="l00953" name="l00953"></a><span class="lineno">  953</span><span class="comment">   *        Object wrapping one the socket objects permitted by `enum` members of Event_type.</span></div>
<div class="line"><a id="l00954" name="l00954"></a><span class="lineno">  954</span><span class="comment">   * @return Hash.</span></div>
<div class="line"><a id="l00955" name="l00955"></a><span class="lineno">  955</span><span class="comment">   */</span></div>
<div class="line"><a id="l00956" name="l00956"></a><span class="lineno">  956</span>  <span class="keywordtype">size_t</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Event__set_1_1Socket__as__any__hash.html#acdda0f516ad0c1e562ff1797cea653cc">operator()</a>(<span class="keyword">const</span> boost::any&amp; sock_as_any) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00957" name="l00957"></a><span class="lineno">  957</span>};</div>
<div class="line"><a id="l00958" name="l00958"></a><span class="lineno">  958</span><span class="comment"></span> </div>
<div class="line"><a id="l00959" name="l00959"></a><span class="lineno">  959</span><span class="comment">/**</span></div>
<div class="line"><a id="l00960" name="l00960"></a><span class="lineno">  960</span><span class="comment"> * Equality predicate class used in storing various sockets of types wrapped as `boost::any`s in the #Sockets type.</span></div>
<div class="line"><a id="l00961" name="l00961"></a><span class="lineno">  961</span><span class="comment"> * We do not simply define `operator==(any, any)`, because our implementation specifically works for `any` objects</span></div>
<div class="line"><a id="l00962" name="l00962"></a><span class="lineno">  962</span><span class="comment"> * that store various sockets and won&#39;t work for all other possibilities; and we don&#39;t want to force this</span></div>
<div class="line"><a id="l00963" name="l00963"></a><span class="lineno">  963</span><span class="comment"> * on every user of `hash&lt;any&gt;`.</span></div>
<div class="line"><a id="l00964" name="l00964"></a><span class="lineno">  964</span><span class="comment"> */</span></div>
<div class="line"><a id="l00965" name="l00965"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Event__set_1_1Socket__as__any__equals.html">  965</a></span><span class="keyword">class </span><a class="code hl_class" href="classflow_1_1net__flow_1_1Event__set_1_1Socket__as__any__equals.html">Event_set::Socket_as_any_equals</a></div>
<div class="line"><a id="l00966" name="l00966"></a><span class="lineno">  966</span>{</div>
<div class="line"><a id="l00967" name="l00967"></a><span class="lineno">  967</span><span class="keyword">public</span>:<span class="comment"></span></div>
<div class="line"><a id="l00968" name="l00968"></a><span class="lineno">  968</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00969" name="l00969"></a><span class="lineno">  969</span><span class="comment">   * Returns whether the two objects, which must be stored in #Sockets objects, are equal by value.</span></div>
<div class="line"><a id="l00970" name="l00970"></a><span class="lineno">  970</span><span class="comment">   *</span></div>
<div class="line"><a id="l00971" name="l00971"></a><span class="lineno">  971</span><span class="comment">   * @param sock_as_any1</span></div>
<div class="line"><a id="l00972" name="l00972"></a><span class="lineno">  972</span><span class="comment">   *        Object wrapping one the socket objects permitted by `enum` members of Event_type.</span></div>
<div class="line"><a id="l00973" name="l00973"></a><span class="lineno">  973</span><span class="comment">   * @param sock_as_any2</span></div>
<div class="line"><a id="l00974" name="l00974"></a><span class="lineno">  974</span><span class="comment">   *        Object wrapping one the socket objects permitted by `enum` members of Event_type.</span></div>
<div class="line"><a id="l00975" name="l00975"></a><span class="lineno">  975</span><span class="comment">   * @return `true` if and only if the two are equal by value.</span></div>
<div class="line"><a id="l00976" name="l00976"></a><span class="lineno">  976</span><span class="comment">   */</span></div>
<div class="line"><a id="l00977" name="l00977"></a><span class="lineno">  977</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Event__set_1_1Socket__as__any__equals.html#a2651cf79dd65bdc60707ff3a368f5d9a">operator()</a>(<span class="keyword">const</span> boost::any&amp; sock_as_any1, <span class="keyword">const</span> boost::any&amp; sock_as_any2) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00978" name="l00978"></a><span class="lineno">  978</span>};</div>
<div class="line"><a id="l00979" name="l00979"></a><span class="lineno">  979</span> </div>
<div class="line"><a id="l00980" name="l00980"></a><span class="lineno">  980</span><span class="comment">// Free functions: in *_fwd.hpp.</span></div>
<div class="line"><a id="l00981" name="l00981"></a><span class="lineno">  981</span> </div>
<div class="line"><a id="l00982" name="l00982"></a><span class="lineno">  982</span><span class="comment">// However the following refer to inner type(s) and hence must be declared here and not _fwd.hpp.</span></div>
<div class="line"><a id="l00983" name="l00983"></a><span class="lineno">  983</span><span class="comment"></span> </div>
<div class="line"><a id="l00984" name="l00984"></a><span class="lineno">  984</span><span class="comment">/**</span></div>
<div class="line"><a id="l00985" name="l00985"></a><span class="lineno">  985</span><span class="comment"> * Prints string representation of given Event_set state to given standard `ostream` and returns the</span></div>
<div class="line"><a id="l00986" name="l00986"></a><span class="lineno">  986</span><span class="comment"> * latter.</span></div>
<div class="line"><a id="l00987" name="l00987"></a><span class="lineno">  987</span><span class="comment"> *</span></div>
<div class="line"><a id="l00988" name="l00988"></a><span class="lineno">  988</span><span class="comment"> * @relatesalso Event_set</span></div>
<div class="line"><a id="l00989" name="l00989"></a><span class="lineno">  989</span><span class="comment"> *</span></div>
<div class="line"><a id="l00990" name="l00990"></a><span class="lineno">  990</span><span class="comment"> * @param os</span></div>
<div class="line"><a id="l00991" name="l00991"></a><span class="lineno">  991</span><span class="comment"> *        Stream to print to.</span></div>
<div class="line"><a id="l00992" name="l00992"></a><span class="lineno">  992</span><span class="comment"> * @param state</span></div>
<div class="line"><a id="l00993" name="l00993"></a><span class="lineno">  993</span><span class="comment"> *        Value to serialize.</span></div>
<div class="line"><a id="l00994" name="l00994"></a><span class="lineno">  994</span><span class="comment"> * @return `os`.</span></div>
<div class="line"><a id="l00995" name="l00995"></a><span class="lineno">  995</span><span class="comment"> */</span></div>
<div class="line"><a id="l00996" name="l00996"></a><span class="lineno">  996</span>std::ostream&amp; <a class="code hl_function" href="namespaceflow_1_1net__flow.html#ab9f537c84f77e9b8fa742fc5dc6d5693">operator&lt;&lt;</a>(std::ostream&amp; os, <a class="code hl_enumeration" href="classflow_1_1net__flow_1_1Event__set.html#a2855bd159b6e63bf448ed1f41b608975">Event_set::State</a> state);</div>
<div class="line"><a id="l00997" name="l00997"></a><span class="lineno">  997</span><span class="comment"></span> </div>
<div class="line"><a id="l00998" name="l00998"></a><span class="lineno">  998</span><span class="comment">/**</span></div>
<div class="line"><a id="l00999" name="l00999"></a><span class="lineno">  999</span><span class="comment"> * Prints string representation of given event type to given standard `ostream` and returns the</span></div>
<div class="line"><a id="l01000" name="l01000"></a><span class="lineno"> 1000</span><span class="comment"> * latter.</span></div>
<div class="line"><a id="l01001" name="l01001"></a><span class="lineno"> 1001</span><span class="comment"> *</span></div>
<div class="line"><a id="l01002" name="l01002"></a><span class="lineno"> 1002</span><span class="comment"> * @relatesalso Event_set</span></div>
<div class="line"><a id="l01003" name="l01003"></a><span class="lineno"> 1003</span><span class="comment"> *</span></div>
<div class="line"><a id="l01004" name="l01004"></a><span class="lineno"> 1004</span><span class="comment"> * @param os</span></div>
<div class="line"><a id="l01005" name="l01005"></a><span class="lineno"> 1005</span><span class="comment"> *        Stream to print to.</span></div>
<div class="line"><a id="l01006" name="l01006"></a><span class="lineno"> 1006</span><span class="comment"> * @param ev_type</span></div>
<div class="line"><a id="l01007" name="l01007"></a><span class="lineno"> 1007</span><span class="comment"> *        Value to serialize.</span></div>
<div class="line"><a id="l01008" name="l01008"></a><span class="lineno"> 1008</span><span class="comment"> * @return `os`.</span></div>
<div class="line"><a id="l01009" name="l01009"></a><span class="lineno"> 1009</span><span class="comment"> */</span></div>
<div class="line"><a id="l01010" name="l01010"></a><span class="lineno"> 1010</span>std::ostream&amp; <a class="code hl_function" href="namespaceflow_1_1net__flow.html#ab9f537c84f77e9b8fa742fc5dc6d5693">operator&lt;&lt;</a>(std::ostream&amp; os, <a class="code hl_enumeration" href="classflow_1_1net__flow_1_1Event__set.html#a19cc3a286c8a11c986d2a59ec1e39a71">Event_set::Event_type</a> ev_type);</div>
<div class="line"><a id="l01011" name="l01011"></a><span class="lineno"> 1011</span> </div>
<div class="line"><a id="l01012" name="l01012"></a><span class="lineno"> 1012</span><span class="comment">// Template implementations.</span></div>
<div class="line"><a id="l01013" name="l01013"></a><span class="lineno"> 1013</span> </div>
<div class="line"><a id="l01014" name="l01014"></a><span class="lineno"> 1014</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Socket&gt;</div>
<div class="line"><a id="l01015" name="l01015"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Event__set.html#a496b760adb19356b4aee9a17ca13b523"> 1015</a></span><span class="keywordtype">bool</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Event__set.html#a496b760adb19356b4aee9a17ca13b523">Event_set::add_wanted_socket</a>(<span class="keyword">typename</span> Socket::Ptr sock, <a class="code hl_enumeration" href="classflow_1_1net__flow_1_1Event__set.html#a19cc3a286c8a11c986d2a59ec1e39a71">Event_type</a> ev_type, <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code)</div>
<div class="line"><a id="l01016" name="l01016"></a><span class="lineno"> 1016</span>{</div>
<div class="line"><a id="l01017" name="l01017"></a><span class="lineno"> 1017</span>  <span class="keyword">using </span>boost::any;</div>
<div class="line"><a id="l01018" name="l01018"></a><span class="lineno"> 1018</span> </div>
<div class="line"><a id="l01019" name="l01019"></a><span class="lineno"> 1019</span>  <a class="code hl_define" href="error_2error_8hpp.html#a636b2d30a8785df6e84646b568bce9b5">FLOW_ERROR_EXEC_AND_THROW_ON_ERROR</a>(<span class="keywordtype">bool</span>, add_wanted_socket&lt;Socket&gt;, sock, ev_type, _1);</div>
<div class="line"><a id="l01020" name="l01020"></a><span class="lineno"> 1020</span>  <span class="comment">// ^-- Call ourselves and return if err_code is null.  If got to present line, err_code is not null.</span></div>
<div class="line"><a id="l01021" name="l01021"></a><span class="lineno"> 1021</span> </div>
<div class="line"><a id="l01022" name="l01022"></a><span class="lineno"> 1022</span>  <span class="comment">// We are in thread U != W.</span></div>
<div class="line"><a id="l01023" name="l01023"></a><span class="lineno"> 1023</span> </div>
<div class="line"><a id="l01024" name="l01024"></a><span class="lineno"> 1024</span>  <span class="comment">// Accessing m_state, socket sets, etc. which may be written by other threads at any time.  Must lock.</span></div>
<div class="line"><a id="l01025" name="l01025"></a><span class="lineno"> 1025</span>  <a class="code hl_typedef" href="classflow_1_1net__flow_1_1Event__set.html#a7e6ff0e1ad4c13220a371045101a5eff">Lock_guard</a> lock(<a class="code hl_variable" href="classflow_1_1net__flow_1_1Event__set.html#a0dda853ab017dd9bfcfb71b601d15698">m_mutex</a>);</div>
<div class="line"><a id="l01026" name="l01026"></a><span class="lineno"> 1026</span> </div>
<div class="line"><a id="l01027" name="l01027"></a><span class="lineno"> 1027</span>  <a class="code hl_define" href="log_8hpp.html#affcf2e4c496ce3f42adf981669c623b8">FLOW_LOG_TRACE</a>(<span class="stringliteral">&quot;Object [&quot;</span> &lt;&lt; sock &lt;&lt; <span class="stringliteral">&quot;] wanted for event type [&quot;</span> &lt;&lt; ev_type &lt;&lt; <span class="stringliteral">&quot;] in Event_set [&quot;</span> &lt;&lt; <span class="keyword">this</span> &lt;&lt; <span class="stringliteral">&quot;].&quot;</span>);</div>
<div class="line"><a id="l01028" name="l01028"></a><span class="lineno"> 1028</span> </div>
<div class="line"><a id="l01029" name="l01029"></a><span class="lineno"> 1029</span>  <span class="keywordflow">if</span> (!<a class="code hl_function" href="classflow_1_1net__flow_1_1Event__set.html#a8e16d91f81860eb2a6c971863548e466">ok_to_mod_socket_set</a>(err_code)) <span class="comment">// Ensure we can modify want_set in this state.</span></div>
<div class="line"><a id="l01030" name="l01030"></a><span class="lineno"> 1030</span>  {</div>
<div class="line"><a id="l01031" name="l01031"></a><span class="lineno"> 1031</span>    <span class="comment">// *err_code is set.</span></div>
<div class="line"><a id="l01032" name="l01032"></a><span class="lineno"> 1032</span>    <span class="keywordflow">return</span> <span class="keyword">false</span>; <span class="comment">// Closed; do not set *target_set (*want_set is blank anyway).</span></div>
<div class="line"><a id="l01033" name="l01033"></a><span class="lineno"> 1033</span>  }</div>
<div class="line"><a id="l01034" name="l01034"></a><span class="lineno"> 1034</span>  <span class="comment">// else *err_code is success.</span></div>
<div class="line"><a id="l01035" name="l01035"></a><span class="lineno"> 1035</span>  assert(!*err_code);</div>
<div class="line"><a id="l01036" name="l01036"></a><span class="lineno"> 1036</span> </div>
<div class="line"><a id="l01037" name="l01037"></a><span class="lineno"> 1037</span>  <span class="comment">/* Note that this method is a template solely because of the following `any(sock)`.  We could&#39;ve made the user</span></div>
<div class="line"><a id="l01038" name="l01038"></a><span class="lineno"> 1038</span><span class="comment">   * perform this conversion themselves and taken a `boost::any` into a non-template method.  We give them a little</span></div>
<div class="line"><a id="l01039" name="l01039"></a><span class="lineno"> 1039</span><span class="comment">   * sugar though. */</span></div>
<div class="line"><a id="l01040" name="l01040"></a><span class="lineno"> 1040</span>  <span class="keyword">static_assert</span>(<a class="code hl_class" href="classflow_1_1util_1_1Container__traits.html">util::Container_traits&lt;Sockets&gt;::S_CONSTANT_TIME_INSERT</a>,</div>
<div class="line"><a id="l01041" name="l01041"></a><span class="lineno"> 1041</span>                <span class="stringliteral">&quot;Expecting amortized constant time insertion sockets container.&quot;</span>); <span class="comment">// Ensure fastness.</span></div>
<div class="line"><a id="l01042" name="l01042"></a><span class="lineno"> 1042</span>  <span class="keywordflow">if</span> (!<a class="code hl_variable" href="classflow_1_1net__flow_1_1Event__set.html#af4fa5dbda4ffd95b35dee57fc01b90ce">m_want</a>[ev_type].insert(any(sock)).second)</div>
<div class="line"><a id="l01043" name="l01043"></a><span class="lineno"> 1043</span>  {</div>
<div class="line"><a id="l01044" name="l01044"></a><span class="lineno"> 1044</span>    <a class="code hl_define" href="error_2error_8hpp.html#ab6b8ed79012c994cfc381e0b92c066fd">FLOW_ERROR_EMIT_ERROR</a>(<a class="code hl_enumvalue" href="namespaceflow_1_1net__flow_1_1error.html#a18e13de77b119ea0f2be411490859482a8f3a13ffefc4897da606c86e60a4422f">error::Code::S_EVENT_SET_EVENT_ALREADY_EXISTS</a>);</div>
<div class="line"><a id="l01045" name="l01045"></a><span class="lineno"> 1045</span>  }</div>
<div class="line"><a id="l01046" name="l01046"></a><span class="lineno"> 1046</span>  <span class="comment">// else { *err_code is still success. }</span></div>
<div class="line"><a id="l01047" name="l01047"></a><span class="lineno"> 1047</span> </div>
<div class="line"><a id="l01048" name="l01048"></a><span class="lineno"> 1048</span>  <span class="keywordflow">return</span> !*err_code;</div>
<div class="line"><a id="l01049" name="l01049"></a><span class="lineno"> 1049</span>}</div>
<div class="line"><a id="l01050" name="l01050"></a><span class="lineno"> 1050</span> </div>
<div class="line"><a id="l01051" name="l01051"></a><span class="lineno"> 1051</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Socket&gt;</div>
<div class="line"><a id="l01052" name="l01052"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Event__set.html#ac3bd92001ec9ca3623a0e84a50043bb9"> 1052</a></span><span class="keywordtype">bool</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Event__set.html#ac3bd92001ec9ca3623a0e84a50043bb9">Event_set::remove_wanted_socket</a>(<span class="keyword">typename</span> Socket::Ptr sock, <a class="code hl_enumeration" href="classflow_1_1net__flow_1_1Event__set.html#a19cc3a286c8a11c986d2a59ec1e39a71">Event_type</a> ev_type, <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code)</div>
<div class="line"><a id="l01053" name="l01053"></a><span class="lineno"> 1053</span>{</div>
<div class="line"><a id="l01054" name="l01054"></a><span class="lineno"> 1054</span>  <a class="code hl_define" href="error_2error_8hpp.html#a636b2d30a8785df6e84646b568bce9b5">FLOW_ERROR_EXEC_AND_THROW_ON_ERROR</a>(<span class="keywordtype">bool</span>, remove_wanted_socket&lt;Socket&gt;, sock, ev_type, _1);</div>
<div class="line"><a id="l01055" name="l01055"></a><span class="lineno"> 1055</span>  <span class="comment">// ^-- Call ourselves and return if err_code is null.  If got to present line, err_code is not null.</span></div>
<div class="line"><a id="l01056" name="l01056"></a><span class="lineno"> 1056</span> </div>
<div class="line"><a id="l01057" name="l01057"></a><span class="lineno"> 1057</span>  <span class="keyword">using </span>boost::any;</div>
<div class="line"><a id="l01058" name="l01058"></a><span class="lineno"> 1058</span> </div>
<div class="line"><a id="l01059" name="l01059"></a><span class="lineno"> 1059</span>  <span class="comment">// We are in thread U != W.</span></div>
<div class="line"><a id="l01060" name="l01060"></a><span class="lineno"> 1060</span> </div>
<div class="line"><a id="l01061" name="l01061"></a><span class="lineno"> 1061</span>  <span class="comment">// Accessing m_state, the sets, etc. which may be written by other threads at any time.  Must lock.</span></div>
<div class="line"><a id="l01062" name="l01062"></a><span class="lineno"> 1062</span>  <a class="code hl_typedef" href="classflow_1_1net__flow_1_1Event__set.html#a7e6ff0e1ad4c13220a371045101a5eff">Lock_guard</a> lock(<a class="code hl_variable" href="classflow_1_1net__flow_1_1Event__set.html#a0dda853ab017dd9bfcfb71b601d15698">m_mutex</a>);</div>
<div class="line"><a id="l01063" name="l01063"></a><span class="lineno"> 1063</span> </div>
<div class="line"><a id="l01064" name="l01064"></a><span class="lineno"> 1064</span>  <a class="code hl_define" href="log_8hpp.html#affcf2e4c496ce3f42adf981669c623b8">FLOW_LOG_TRACE</a>(<span class="stringliteral">&quot;Object [&quot;</span> &lt;&lt; sock &lt;&lt; <span class="stringliteral">&quot;] no longer wanted for event type [&quot;</span> &lt;&lt; ev_type &lt;&lt; <span class="stringliteral">&quot;] in &quot;</span></div>
<div class="line"><a id="l01065" name="l01065"></a><span class="lineno"> 1065</span>                 <span class="stringliteral">&quot;Event_set [&quot;</span> &lt;&lt; <span class="keyword">this</span> &lt;&lt; <span class="stringliteral">&quot;].&quot;</span>);</div>
<div class="line"><a id="l01066" name="l01066"></a><span class="lineno"> 1066</span> </div>
<div class="line"><a id="l01067" name="l01067"></a><span class="lineno"> 1067</span>  <span class="keywordflow">if</span> (!<a class="code hl_function" href="classflow_1_1net__flow_1_1Event__set.html#a8e16d91f81860eb2a6c971863548e466">ok_to_mod_socket_set</a>(err_code)) <span class="comment">// Ensure we can modify want_set in this state.</span></div>
<div class="line"><a id="l01068" name="l01068"></a><span class="lineno"> 1068</span>  {</div>
<div class="line"><a id="l01069" name="l01069"></a><span class="lineno"> 1069</span>    <span class="comment">// *err_code is set.</span></div>
<div class="line"><a id="l01070" name="l01070"></a><span class="lineno"> 1070</span>    <span class="keywordflow">return</span> <span class="keyword">false</span>; <span class="comment">// Closed; do not set *target_set (*want_set is blank anyway).</span></div>
<div class="line"><a id="l01071" name="l01071"></a><span class="lineno"> 1071</span>  }</div>
<div class="line"><a id="l01072" name="l01072"></a><span class="lineno"> 1072</span>  <span class="comment">// else *err_code is success.</span></div>
<div class="line"><a id="l01073" name="l01073"></a><span class="lineno"> 1073</span> </div>
<div class="line"><a id="l01074" name="l01074"></a><span class="lineno"> 1074</span>  <a class="code hl_class" href="classflow_1_1util_1_1Linked__hash__set.html">Sockets</a>&amp; want_set = <a class="code hl_variable" href="classflow_1_1net__flow_1_1Event__set.html#af4fa5dbda4ffd95b35dee57fc01b90ce">m_want</a>[ev_type];</div>
<div class="line"><a id="l01075" name="l01075"></a><span class="lineno"> 1075</span>  <span class="comment">/* Note that this method is a template solely because of the following assignment.  We could&#39;ve made the user</span></div>
<div class="line"><a id="l01076" name="l01076"></a><span class="lineno"> 1076</span><span class="comment">   * perform this conversion themselves and taken a `boost::any` into an non-template method.  We give them a little</span></div>
<div class="line"><a id="l01077" name="l01077"></a><span class="lineno"> 1077</span><span class="comment">   * sugar though. */</span></div>
<div class="line"><a id="l01078" name="l01078"></a><span class="lineno"> 1078</span>  <span class="keyword">const</span> any sock_as_any = sock;</div>
<div class="line"><a id="l01079" name="l01079"></a><span class="lineno"> 1079</span> </div>
<div class="line"><a id="l01080" name="l01080"></a><span class="lineno"> 1080</span>  <span class="keyword">const</span> <span class="keywordtype">bool</span> did_erase = want_set.<a class="code hl_function" href="classflow_1_1util_1_1Linked__hash__set.html#a4b63c73e7c2d6092331cb7bd3267b830">erase</a>(sock_as_any) == 1;</div>
<div class="line"><a id="l01081" name="l01081"></a><span class="lineno"> 1081</span>  <span class="keywordflow">if</span> (!did_erase)</div>
<div class="line"><a id="l01082" name="l01082"></a><span class="lineno"> 1082</span>  {</div>
<div class="line"><a id="l01083" name="l01083"></a><span class="lineno"> 1083</span>    <a class="code hl_define" href="error_2error_8hpp.html#ab6b8ed79012c994cfc381e0b92c066fd">FLOW_ERROR_EMIT_ERROR</a>(<a class="code hl_enumvalue" href="namespaceflow_1_1net__flow_1_1error.html#a18e13de77b119ea0f2be411490859482a96f464959b6ce918048a2167c23f1c0b">error::Code::S_EVENT_SET_EVENT_DOES_NOT_EXIST</a>);</div>
<div class="line"><a id="l01084" name="l01084"></a><span class="lineno"> 1084</span>    <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line"><a id="l01085" name="l01085"></a><span class="lineno"> 1085</span>  }</div>
<div class="line"><a id="l01086" name="l01086"></a><span class="lineno"> 1086</span>  <span class="comment">// else *err_code is success.</span></div>
<div class="line"><a id="l01087" name="l01087"></a><span class="lineno"> 1087</span> </div>
<div class="line"><a id="l01088" name="l01088"></a><span class="lineno"> 1088</span>  <span class="keywordflow">return</span> <span class="keyword">true</span>;</div>
<div class="line"><a id="l01089" name="l01089"></a><span class="lineno"> 1089</span>} <span class="comment">// Event_set::remove_wanted_socket()</span></div>
<div class="line"><a id="l01090" name="l01090"></a><span class="lineno"> 1090</span> </div>
<div class="line"><a id="l01091" name="l01091"></a><span class="lineno"> 1091</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Rep, <span class="keyword">typename</span> Period&gt;</div>
<div class="line"><a id="l01092" name="l01092"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1Event__set.html#a7272a3b8975ff72edd3db3f777e930f1"> 1092</a></span><span class="keywordtype">bool</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Event__set.html#a133c518168fe3922ab6729a99077dd3f">Event_set::sync_wait</a>(<span class="keyword">const</span> boost::chrono::duration&lt;Rep, Period&gt;&amp; max_wait, <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code)</div>
<div class="line"><a id="l01093" name="l01093"></a><span class="lineno"> 1093</span>{</div>
<div class="line"><a id="l01094" name="l01094"></a><span class="lineno"> 1094</span>  assert(max_wait.count() &gt; 0);</div>
<div class="line"><a id="l01095" name="l01095"></a><span class="lineno"> 1095</span>  <span class="keywordflow">return</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1Event__set.html#a13a17c404f0ce43da5fec53a550da9be">sync_wait_impl</a>(<a class="code hl_function" href="namespaceflow_1_1util.html#aa60d3ba517b5f5cf408faa92d269256a">util::chrono_duration_to_fine_duration</a>(max_wait), err_code);</div>
<div class="line"><a id="l01096" name="l01096"></a><span class="lineno"> 1096</span>}</div>
<div class="line"><a id="l01097" name="l01097"></a><span class="lineno"> 1097</span> </div>
<div class="line"><a id="l01098" name="l01098"></a><span class="lineno"> 1098</span>} <span class="comment">// namespace flow::net_flow</span></div>
<div class="ttc" id="aclassbool_html"><div class="ttname"><a href="classbool.html">bool</a></div></div>
<div class="ttc" id="aclassflow_1_1Function_html"><div class="ttname"><a href="classflow_1_1Function.html">flow::Function&lt; void(bool)&gt;</a></div></div>
<div class="ttc" id="aclassflow_1_1log_1_1Log__context_html"><div class="ttname"><a href="classflow_1_1log_1_1Log__context.html">flow::log::Log_context</a></div><div class="ttdoc">Convenience class that simply stores a Logger and/or Component passed into a constructor; and returns...</div><div class="ttdef"><b>Definition:</b> <a href="log_8hpp_source.html#l01609">log.hpp:1610</a></div></div>
<div class="ttc" id="aclassflow_1_1log_1_1Logger_html"><div class="ttname"><a href="classflow_1_1log_1_1Logger.html">flow::log::Logger</a></div><div class="ttdoc">Interface that the user should implement, passing the implementing Logger into logging classes (Flow'...</div><div class="ttdef"><b>Definition:</b> <a href="log_8hpp_source.html#l01280">log.hpp:1284</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Event__set_1_1Socket__as__any__equals_html"><div class="ttname"><a href="classflow_1_1net__flow_1_1Event__set_1_1Socket__as__any__equals.html">flow::net_flow::Event_set::Socket_as_any_equals</a></div><div class="ttdoc">Equality predicate class used in storing various sockets of types wrapped as boost::anys in the Socke...</div><div class="ttdef"><b>Definition:</b> <a href="event__set_8hpp_source.html#l00965">event_set.hpp:966</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Event__set_1_1Socket__as__any__equals_html_a2651cf79dd65bdc60707ff3a368f5d9a"><div class="ttname"><a href="classflow_1_1net__flow_1_1Event__set_1_1Socket__as__any__equals.html#a2651cf79dd65bdc60707ff3a368f5d9a">flow::net_flow::Event_set::Socket_as_any_equals::operator()</a></div><div class="ttdeci">bool operator()(const boost::any &amp;sock_as_any1, const boost::any &amp;sock_as_any2) const</div><div class="ttdoc">Returns whether the two objects, which must be stored in Sockets objects, are equal by value.</div><div class="ttdef"><b>Definition:</b> <a href="event__set_8cpp_source.html#l00836">event_set.cpp:836</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Event__set_1_1Socket__as__any__hash_html"><div class="ttname"><a href="classflow_1_1net__flow_1_1Event__set_1_1Socket__as__any__hash.html">flow::net_flow::Event_set::Socket_as_any_hash</a></div><div class="ttdoc">Hasher class used in storing various sockets of types wrapped as boost::anys in the Sockets type.</div><div class="ttdef"><b>Definition:</b> <a href="event__set_8hpp_source.html#l00946">event_set.hpp:947</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Event__set_1_1Socket__as__any__hash_html_acdda0f516ad0c1e562ff1797cea653cc"><div class="ttname"><a href="classflow_1_1net__flow_1_1Event__set_1_1Socket__as__any__hash.html#acdda0f516ad0c1e562ff1797cea653cc">flow::net_flow::Event_set::Socket_as_any_hash::operator()</a></div><div class="ttdeci">size_t operator()(const boost::any &amp;sock_as_any) const</div><div class="ttdoc">Returns hash value of the given object which must be stored in a Sockets object.</div><div class="ttdef"><b>Definition:</b> <a href="event__set_8cpp_source.html#l00807">event_set.cpp:807</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Event__set_html"><div class="ttname"><a href="classflow_1_1net__flow_1_1Event__set.html">flow::net_flow::Event_set</a></div><div class="ttdoc">A user-set collection of sockets and desired conditions on those sockets (such as: &quot;socket has data t...</div><div class="ttdef"><b>Definition:</b> <a href="event__set_8hpp_source.html#l00247">event_set.hpp:254</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Event__set_html_a0dda853ab017dd9bfcfb71b601d15698"><div class="ttname"><a href="classflow_1_1net__flow_1_1Event__set.html#a0dda853ab017dd9bfcfb71b601d15698">flow::net_flow::Event_set::m_mutex</a></div><div class="ttdeci">Mutex m_mutex</div><div class="ttdoc">Mutex protecting ALL data in this object.</div><div class="ttdef"><b>Definition:</b> <a href="event__set_8hpp_source.html#l00937">event_set.hpp:937</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Event__set_html_a0edced1cb69b2cad299ee32e652ccea7"><div class="ttname"><a href="classflow_1_1net__flow_1_1Event__set.html#a0edced1cb69b2cad299ee32e652ccea7">flow::net_flow::Event_set::clear_ev_type_to_socks_map</a></div><div class="ttdeci">static void clear_ev_type_to_socks_map(Ev_type_to_socks_map *ev_type_to_socks_map)</div><div class="ttdoc">Helper that clears each Sockets set inside an Ev_type_to_socks_map.</div><div class="ttdef"><b>Definition:</b> <a href="event__set_8cpp_source.html#l00745">event_set.cpp:745</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Event__set_html_a133c518168fe3922ab6729a99077dd3f"><div class="ttname"><a href="classflow_1_1net__flow_1_1Event__set.html#a133c518168fe3922ab6729a99077dd3f">flow::net_flow::Event_set::sync_wait</a></div><div class="ttdeci">bool sync_wait(Error_code *err_code=0)</div><div class="ttdoc">Blocks indefinitely until one or more of the previously described events hold – or the wait is interr...</div><div class="ttdef"><b>Definition:</b> <a href="event__set_8cpp_source.html#l00457">event_set.cpp:457</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Event__set_html_a13a17c404f0ce43da5fec53a550da9be"><div class="ttname"><a href="classflow_1_1net__flow_1_1Event__set.html#a13a17c404f0ce43da5fec53a550da9be">flow::net_flow::Event_set::sync_wait_impl</a></div><div class="ttdeci">bool sync_wait_impl(const Fine_duration &amp;max_wait, Error_code *err_code)</div><div class="ttdoc">Same as the public sync_wait(max_wait) but uses a Fine_clock-based Fine_duration non-template type fo...</div><div class="ttdef"><b>Definition:</b> <a href="event__set_8cpp_source.html#l00335">event_set.cpp:335</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Event__set_html_a19cc3a286c8a11c986d2a59ec1e39a71"><div class="ttname"><a href="classflow_1_1net__flow_1_1Event__set.html#a19cc3a286c8a11c986d2a59ec1e39a71">flow::net_flow::Event_set::Event_type</a></div><div class="ttdeci">Event_type</div><div class="ttdoc">Type of event or condition of interest supported by class Event_set.</div><div class="ttdef"><b>Definition:</b> <a href="event__set_8hpp_source.html#l00306">event_set.hpp:307</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Event__set_html_a19e241ae4dfe1ea54de6027052bc2135"><div class="ttname"><a href="classflow_1_1net__flow_1_1Event__set.html#a19e241ae4dfe1ea54de6027052bc2135">flow::net_flow::Event_set::ev_type_to_socks_map_sizes_to_str</a></div><div class="ttdeci">static std::string ev_type_to_socks_map_sizes_to_str(const Ev_type_to_socks_map &amp;ev_type_to_socks_map)</div><div class="ttdoc">Helper that returns a loggable string summarizing the sizes of the socket sets, by type,...</div><div class="ttdef"><b>Definition:</b> <a href="event__set_8cpp_source.html#l00759">event_set.cpp:759</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Event__set_html_a2855bd159b6e63bf448ed1f41b608975"><div class="ttname"><a href="classflow_1_1net__flow_1_1Event__set.html#a2855bd159b6e63bf448ed1f41b608975">flow::net_flow::Event_set::State</a></div><div class="ttdeci">State</div><div class="ttdoc">A state of an Event_set.</div><div class="ttdef"><b>Definition:</b> <a href="event__set_8hpp_source.html#l00259">event_set.hpp:260</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Event__set_html_a3122100c044da08495fac737998f60db"><div class="ttname"><a href="classflow_1_1net__flow_1_1Event__set.html#a3122100c044da08495fac737998f60db">flow::net_flow::Event_set::async_wait_finish</a></div><div class="ttdeci">bool async_wait_finish(Error_code *err_code=0)</div><div class="ttdoc">Moves object from State::S_WAITING to State::S_INACTIVE, and forgets any handler saved by async_wait(...</div><div class="ttdef"><b>Definition:</b> <a href="event__set_8cpp_source.html#l00214">event_set.cpp:214</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Event__set_html_a314635daf8fdf3805868baff8b42cfc9"><div class="ttname"><a href="classflow_1_1net__flow_1_1Event__set.html#a314635daf8fdf3805868baff8b42cfc9">flow::net_flow::Event_set::events_detected</a></div><div class="ttdeci">bool events_detected(Error_code *err_code=0) const</div><div class="ttdoc">Returns true if and only if the last wait, if any, detected at least one event.</div><div class="ttdef"><b>Definition:</b> <a href="event__set_8cpp_source.html#l00574">event_set.cpp:574</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Event__set_html_a412214de6a4f3a1ff1e86ddb1975f47b"><div class="ttname"><a href="classflow_1_1net__flow_1_1Event__set.html#a412214de6a4f3a1ff1e86ddb1975f47b">flow::net_flow::Event_set::poll</a></div><div class="ttdeci">bool poll(Error_code *err_code=0)</div><div class="ttdoc">Checks for all previously described events that currently hold, saves them for retrieval via emit_res...</div><div class="ttdef"><b>Definition:</b> <a href="event__set_8cpp_source.html#l00265">event_set.cpp:265</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Event__set_html_a43dfb881ab3a9488a6a60dd83ad21c85"><div class="ttname"><a href="classflow_1_1net__flow_1_1Event__set.html#a43dfb881ab3a9488a6a60dd83ad21c85">flow::net_flow::Event_set::async_wait</a></div><div class="ttdeci">bool async_wait(const Event_handler &amp;on_event, Error_code *err_code=0)</div><div class="ttdoc">Moves object to State::S_WAITING state, saves the given handler to be executed later (in a different,...</div><div class="ttdef"><b>Definition:</b> <a href="event__set_8cpp_source.html#l00072">event_set.cpp:72</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Event__set_html_a47e4e6d304a6a381e7469fe87c547738"><div class="ttname"><a href="classflow_1_1net__flow_1_1Event__set.html#a47e4e6d304a6a381e7469fe87c547738">flow::net_flow::Event_set::Mutex</a></div><div class="ttdeci">util::Mutex_recursive Mutex</div><div class="ttdoc">Short-hand for reentrant mutex type.</div><div class="ttdef"><b>Definition:</b> <a href="event__set_8hpp_source.html#l00788">event_set.hpp:788</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Event__set_html_a496b760adb19356b4aee9a17ca13b523"><div class="ttname"><a href="classflow_1_1net__flow_1_1Event__set.html#a496b760adb19356b4aee9a17ca13b523">flow::net_flow::Event_set::add_wanted_socket</a></div><div class="ttdeci">bool add_wanted_socket(typename Socket::Ptr sock, Event_type ev_type, Error_code *err_code=0)</div><div class="ttdoc">Adds the given socket to the set of sockets we want to know are &quot;ready&quot; by the definition of the give...</div><div class="ttdef"><b>Definition:</b> <a href="event__set_8hpp_source.html#l01015">event_set.hpp:1015</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Event__set_html_a56925e15b38d285f387e10bfb18f93c9"><div class="ttname"><a href="classflow_1_1net__flow_1_1Event__set.html#a56925e15b38d285f387e10bfb18f93c9">flow::net_flow::Event_set::m_state</a></div><div class="ttdeci">State m_state</div><div class="ttdoc">See state(). Should be set before user gets access to *this. Must not be modified by non-W threads af...</div><div class="ttdef"><b>Definition:</b> <a href="event__set_8hpp_source.html#l00901">event_set.hpp:901</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Event__set_html_a59f6ddb0d0258cc029c435a8ed0f89f7"><div class="ttname"><a href="classflow_1_1net__flow_1_1Event__set.html#a59f6ddb0d0258cc029c435a8ed0f89f7">flow::net_flow::Event_set::m_on_event</a></div><div class="ttdeci">Event_handler m_on_event</div><div class="ttdoc">During State::S_WAITING, stores the handler (a void function with 1 bool argument) that will be calle...</div><div class="ttdef"><b>Definition:</b> <a href="event__set_8hpp_source.html#l00926">event_set.hpp:926</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Event__set_html_a6e47fc394c09acf4d100a640e090a7aa"><div class="ttname"><a href="classflow_1_1net__flow_1_1Event__set.html#a6e47fc394c09acf4d100a640e090a7aa">flow::net_flow::Event_set::swap_wanted_sockets</a></div><div class="ttdeci">bool swap_wanted_sockets(Sockets *target_set, Event_type ev_type, Error_code *err_code)</div><div class="ttdoc">Efficiently exchanges the current set of sockets we want to know are &quot;ready&quot; by the definiton of the ...</div><div class="ttdef"><b>Definition:</b> <a href="event__set_8cpp_source.html#l00492">event_set.cpp:492</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Event__set_html_a72b26f25a2e76e3c61b4760b59de5b25"><div class="ttname"><a href="classflow_1_1net__flow_1_1Event__set.html#a72b26f25a2e76e3c61b4760b59de5b25">flow::net_flow::Event_set::emit_result_sockets</a></div><div class="ttdeci">bool emit_result_sockets(Sockets *target_set, Event_type ev_type, Error_code *err_code=0)</div><div class="ttdoc">Gets the sockets that satisfy the condition of the given Event_type detected during the last wait.</div><div class="ttdef"><b>Definition:</b> <a href="event__set_8cpp_source.html#l00611">event_set.cpp:611</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Event__set_html_a79d75ea514f571d9f6bd2cfcad502f22"><div class="ttname"><a href="classflow_1_1net__flow_1_1Event__set.html#a79d75ea514f571d9f6bd2cfcad502f22">flow::net_flow::Event_set::empty_ev_type_to_socks_map</a></div><div class="ttdeci">static Ev_type_to_socks_map empty_ev_type_to_socks_map()</div><div class="ttdoc">Creates a maximally empty Ev_type_to_socks_map: it will have all possible Event_type as keys but only...</div><div class="ttdef"><b>Definition:</b> <a href="event__set_8cpp_source.html#l00734">event_set.cpp:734</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Event__set_html_a7b8e6cf7046b6905015301a203cd88f5"><div class="ttname"><a href="classflow_1_1net__flow_1_1Event__set.html#a7b8e6cf7046b6905015301a203cd88f5">flow::net_flow::Event_set::Event_set</a></div><div class="ttdeci">Event_set(log::Logger *logger_ptr)</div><div class="ttdoc">Constructs object; initializes all values to well-defined but possibly meaningless values (0,...</div><div class="ttdef"><b>Definition:</b> <a href="event__set_8cpp_source.html#l00042">event_set.cpp:42</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Event__set_html_a7e6ff0e1ad4c13220a371045101a5eff"><div class="ttname"><a href="classflow_1_1net__flow_1_1Event__set.html#a7e6ff0e1ad4c13220a371045101a5eff">flow::net_flow::Event_set::Lock_guard</a></div><div class="ttdeci">util::Lock_guard&lt; Mutex &gt; Lock_guard</div><div class="ttdoc">Short-hand for RAII lock guard of Mutex. Use instead of boost::lock_guard for release() at least.</div><div class="ttdef"><b>Definition:</b> <a href="event__set_8hpp_source.html#l00791">event_set.hpp:791</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Event__set_html_a8453cccdaaf22ea6b027c5de9738f0f0"><div class="ttname"><a href="classflow_1_1net__flow_1_1Event__set.html#a8453cccdaaf22ea6b027c5de9738f0f0">flow::net_flow::Event_set::state</a></div><div class="ttdeci">State state() const</div><div class="ttdoc">Current State of the Event_set.</div><div class="ttdef"><b>Definition:</b> <a href="event__set_8cpp_source.html#l00060">event_set.cpp:60</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Event__set_html_a86ddd6fb8874d85869157bae2ffda69b"><div class="ttname"><a href="classflow_1_1net__flow_1_1Event__set.html#a86ddd6fb8874d85869157bae2ffda69b">flow::net_flow::Event_set::clear_wanted_sockets</a></div><div class="ttdeci">bool clear_wanted_sockets(Event_type ev_type, Error_code *err_code=0)</div><div class="ttdoc">Identical to swap_wanted_sockets(&amp;sockets, ev_type, err_code), where originally sockets is empty and ...</div><div class="ttdef"><b>Definition:</b> <a href="event__set_8cpp_source.html#l00525">event_set.cpp:525</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Event__set_html_a8e16d91f81860eb2a6c971863548e466"><div class="ttname"><a href="classflow_1_1net__flow_1_1Event__set.html#a8e16d91f81860eb2a6c971863548e466">flow::net_flow::Event_set::ok_to_mod_socket_set</a></div><div class="ttdeci">bool ok_to_mod_socket_set(Error_code *err_code) const</div><div class="ttdoc">Helper that ensures the state of *this is such that one may modify the m_can and m_want socket sets.</div><div class="ttdef"><b>Definition:</b> <a href="event__set_8cpp_source.html#l00673">event_set.cpp:673</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Event__set_html_a976144f6e525190344eb4e51620f9fd9"><div class="ttname"><a href="classflow_1_1net__flow_1_1Event__set.html#a976144f6e525190344eb4e51620f9fd9">flow::net_flow::Event_set::events_wanted</a></div><div class="ttdeci">bool events_wanted(Error_code *err_code=0) const</div><div class="ttdoc">Returns true if and only if at least one wanted event for at least one socket is registered (via add_...</div><div class="ttdef"><b>Definition:</b> <a href="event__set_8cpp_source.html#l00551">event_set.cpp:551</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Event__set_html_a9ae292072a84d07c867536e3de3b878e"><div class="ttname"><a href="classflow_1_1net__flow_1_1Event__set.html#a9ae292072a84d07c867536e3de3b878e">flow::net_flow::Event_set::close</a></div><div class="ttdeci">void close(Error_code *err_code=0)</div><div class="ttdoc">Clears all stored resources (any desired events, result events, and any handler saved by async_wait()...</div><div class="ttdef"><b>Definition:</b> <a href="event__set_8cpp_source.html#l00463">event_set.cpp:463</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Event__set_html_aa321c69146b8575e4d0e3b15c67d4f08"><div class="ttname"><a href="classflow_1_1net__flow_1_1Event__set.html#aa321c69146b8575e4d0e3b15c67d4f08">flow::net_flow::Event_set::S_EV_TYPE_TO_IS_ACTIVE_NODE_MTD</a></div><div class="ttdeci">static const boost::unordered_map&lt; Event_type, Function&lt; bool(const Node *, const boost::any &amp;)&gt; &gt; S_EV_TYPE_TO_IS_ACTIVE_NODE_MTD</div><div class="ttdoc">Mapping from each possible Event_type to the Node method that determines whether the condition define...</div><div class="ttdef"><b>Definition:</b> <a href="event__set_8hpp_source.html#l00897">event_set.hpp:897</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Event__set_html_aafa4275ad4f93ae274f7f88fd257ce33"><div class="ttname"><a href="classflow_1_1net__flow_1_1Event__set.html#aafa4275ad4f93ae274f7f88fd257ce33">flow::net_flow::Event_set::node</a></div><div class="ttdeci">Node * node() const</div><div class="ttdoc">Node that produced this Event_set.</div><div class="ttdef"><b>Definition:</b> <a href="event__set_8cpp_source.html#l00066">event_set.cpp:66</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Event__set_html_ab64e128595b701e37256ff79d782c146"><div class="ttname"><a href="classflow_1_1net__flow_1_1Event__set.html#ab64e128595b701e37256ff79d782c146">flow::net_flow::Event_set::clear</a></div><div class="ttdeci">bool clear(Error_code *err_code=0)</div><div class="ttdoc">Forgets all sockets stored in this object in any fashion.</div><div class="ttdef"><b>Definition:</b> <a href="event__set_8cpp_source.html#l00703">event_set.cpp:703</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Event__set_html_abf8a102c621b1536659973b2d6b33822"><div class="ttname"><a href="classflow_1_1net__flow_1_1Event__set.html#abf8a102c621b1536659973b2d6b33822">flow::net_flow::Event_set::m_can</a></div><div class="ttdeci">Ev_type_to_socks_map m_can</div><div class="ttdoc">The sockets, categorized by Event_type of interest, that were found to be &quot;ready&quot; (as defined in the ...</div><div class="ttdef"><b>Definition:</b> <a href="event__set_8hpp_source.html#l00920">event_set.hpp:920</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Event__set_html_ac3bd92001ec9ca3623a0e84a50043bb9"><div class="ttname"><a href="classflow_1_1net__flow_1_1Event__set.html#ac3bd92001ec9ca3623a0e84a50043bb9">flow::net_flow::Event_set::remove_wanted_socket</a></div><div class="ttdeci">bool remove_wanted_socket(typename Socket::Ptr sock, Event_type ev_type, Error_code *err_code=0)</div><div class="ttdoc">Opposite of add_wanted_socket().</div><div class="ttdef"><b>Definition:</b> <a href="event__set_8hpp_source.html#l01052">event_set.hpp:1052</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Event__set_html_accb662e50999e2d0800f59a7a131bffa"><div class="ttname"><a href="classflow_1_1net__flow_1_1Event__set.html#accb662e50999e2d0800f59a7a131bffa">flow::net_flow::Event_set::~Event_set</a></div><div class="ttdeci">~Event_set()</div><div class="ttdoc">Boring destructor. Note that deletion is to be handled exclusively via shared_ptr,...</div><div class="ttdef"><b>Definition:</b> <a href="event__set_8cpp_source.html#l00054">event_set.cpp:54</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Event__set_html_ada8d103341b6450f3390dc6ce24ccdef"><div class="ttname"><a href="classflow_1_1net__flow_1_1Event__set.html#ada8d103341b6450f3390dc6ce24ccdef">flow::net_flow::Event_set::m_baseline_check_pending</a></div><div class="ttdeci">bool m_baseline_check_pending</div><div class="ttdoc">While in State::S_WAITING, if this is true, an exhaustive check of all desired events is yet to be pe...</div><div class="ttdef"><b>Definition:</b> <a href="event__set_8hpp_source.html#l00934">event_set.hpp:934</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Event__set_html_ae04c117b15179ba37a94f6836c63497b"><div class="ttname"><a href="classflow_1_1net__flow_1_1Event__set.html#ae04c117b15179ba37a94f6836c63497b">flow::net_flow::Event_set::sock_as_any_to_str</a></div><div class="ttdeci">static std::string sock_as_any_to_str(const boost::any &amp;sock_as_any)</div><div class="ttdoc">Helper that returns a loggable string representing the socket stored in the given boost::any that sto...</div><div class="ttdef"><b>Definition:</b> <a href="event__set_8cpp_source.html#l00775">event_set.cpp:775</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Event__set_html_aed9505b886c78169fe35b527f4e01855"><div class="ttname"><a href="classflow_1_1net__flow_1_1Event__set.html#aed9505b886c78169fe35b527f4e01855">flow::net_flow::Event_set::ev_type_to_socks_map_entry_is_empty</a></div><div class="ttdeci">static bool ev_type_to_socks_map_entry_is_empty(const Ev_type_to_socks_map::Value &amp;ev_type_and_socks)</div><div class="ttdoc">Functional helper that checks whether a given pair in an Ev_type_to_socks_map contains an empty set o...</div><div class="ttdef"><b>Definition:</b> <a href="event__set_8cpp_source.html#l00754">event_set.cpp:754</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Event__set_html_af4fa5dbda4ffd95b35dee57fc01b90ce"><div class="ttname"><a href="classflow_1_1net__flow_1_1Event__set.html#af4fa5dbda4ffd95b35dee57fc01b90ce">flow::net_flow::Event_set::m_want</a></div><div class="ttdeci">Ev_type_to_socks_map m_want</div><div class="ttdoc">The sockets, categorized by Event_type of interest, to check for &quot;ready&quot; status (as defined in the do...</div><div class="ttdef"><b>Definition:</b> <a href="event__set_8hpp_source.html#l00910">event_set.hpp:910</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Event__set_html_af635301685a4a331142e1ac8a791a65d"><div class="ttname"><a href="classflow_1_1net__flow_1_1Event__set.html#af635301685a4a331142e1ac8a791a65d">flow::net_flow::Event_set::m_node</a></div><div class="ttdeci">Node * m_node</div><div class="ttdoc">See node(). Should be set before user gets access to *this. Must not be modified by non-W threads aft...</div><div class="ttdef"><b>Definition:</b> <a href="event__set_8hpp_source.html#l00904">event_set.hpp:904</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Event__set_html_afb6379c7fe127c26fd4cdc9752ccf9e2"><div class="ttname"><a href="classflow_1_1net__flow_1_1Event__set.html#afb6379c7fe127c26fd4cdc9752ccf9e2">flow::net_flow::Event_set::clear_result_sockets</a></div><div class="ttdeci">bool clear_result_sockets(Event_type ev_type, Error_code *err_code=0)</div><div class="ttdoc">Identical to emit_result_sockets(&amp;sockets, ev_type, err_code), where originally sockets is empty and ...</div><div class="ttdef"><b>Definition:</b> <a href="event__set_8cpp_source.html#l00647">event_set.cpp:647</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Node_html"><div class="ttname"><a href="classflow_1_1net__flow_1_1Node.html">flow::net_flow::Node</a></div><div class="ttdoc">An object of this class is a single Flow-protocol networking node, in the sense that: (1) it has a di...</div><div class="ttdef"><b>Definition:</b> <a href="node_8hpp_source.html#l00930">node.hpp:934</a></div></div>
<div class="ttc" id="aclassflow_1_1util_1_1Container__traits_html"><div class="ttname"><a href="classflow_1_1util_1_1Container__traits.html">flow::util::Container_traits</a></div><div class="ttdoc">Properties of various container types.</div><div class="ttdef"><b>Definition:</b> <a href="traits_8hpp_source.html#l00042">traits.hpp:43</a></div></div>
<div class="ttc" id="aclassflow_1_1util_1_1Linked__hash__map_html"><div class="ttname"><a href="classflow_1_1util_1_1Linked__hash__map.html">flow::util::Linked_hash_map&lt; Event_type, Sockets &gt;</a></div></div>
<div class="ttc" id="aclassflow_1_1util_1_1Linked__hash__map_html_af8b3b1128da79536a4c86e9feadb0c66"><div class="ttname"><a href="classflow_1_1util_1_1Linked__hash__map.html#af8b3b1128da79536a4c86e9feadb0c66">flow::util::Linked_hash_map&lt; Event_type, Sockets &gt;::Value</a></div><div class="ttdeci">std::pair&lt; Event_type const, Sockets &gt; Value</div><div class="ttdoc">Short-hand for key/mapped-value pairs stored in the structure.</div><div class="ttdef"><b>Definition:</b> <a href="linked__hash__map_8hpp_source.html#l00081">linked_hash_map.hpp:81</a></div></div>
<div class="ttc" id="aclassflow_1_1util_1_1Linked__hash__set_html"><div class="ttname"><a href="classflow_1_1util_1_1Linked__hash__set.html">flow::util::Linked_hash_set</a></div><div class="ttdoc">An object of this class is a set that combines the lookup speed of an unordered_set&lt;&gt; and ordering an...</div><div class="ttdef"><b>Definition:</b> <a href="linked__hash__set_8hpp_source.html#l00047">linked_hash_set.hpp:48</a></div></div>
<div class="ttc" id="aclassflow_1_1util_1_1Linked__hash__set_html_a4b63c73e7c2d6092331cb7bd3267b830"><div class="ttname"><a href="classflow_1_1util_1_1Linked__hash__set.html#a4b63c73e7c2d6092331cb7bd3267b830">flow::util::Linked_hash_set::erase</a></div><div class="ttdeci">Iterator erase(Const_iterator const &amp;it)</div><div class="ttdoc">Erases the element pointed to by the given valid iterator.</div><div class="ttdef"><b>Definition:</b> <a href="linked__hash__set_8hpp_source.html#l00671">linked_hash_set.hpp:671</a></div></div>
<div class="ttc" id="aclassflow_1_1util_1_1Shared__ptr__alias__holder_html"><div class="ttname"><a href="classflow_1_1util_1_1Shared__ptr__alias__holder.html">flow::util::Shared_ptr_alias_holder</a></div><div class="ttdoc">Convenience class template that endows the given subclass T with nested aliases Ptr and Const_ptr ali...</div><div class="ttdef"><b>Definition:</b> <a href="shared__ptr__alias__holder_8hpp_source.html#l00119">shared_ptr_alias_holder.hpp:120</a></div></div>
<div class="ttc" id="aerror_2error_8hpp_html_a636b2d30a8785df6e84646b568bce9b5"><div class="ttname"><a href="error_2error_8hpp.html#a636b2d30a8785df6e84646b568bce9b5">FLOW_ERROR_EXEC_AND_THROW_ON_ERROR</a></div><div class="ttdeci">#define FLOW_ERROR_EXEC_AND_THROW_ON_ERROR(ARG_ret_type, ARG_function_name,...)</div><div class="ttdoc">Narrow-use macro that implements the error code/exception semantics expected of most public-facing Fl...</div><div class="ttdef"><b>Definition:</b> <a href="error_2error_8hpp_source.html#l00363">error.hpp:363</a></div></div>
<div class="ttc" id="aerror_2error_8hpp_html_ab6b8ed79012c994cfc381e0b92c066fd"><div class="ttname"><a href="error_2error_8hpp.html#ab6b8ed79012c994cfc381e0b92c066fd">FLOW_ERROR_EMIT_ERROR</a></div><div class="ttdeci">#define FLOW_ERROR_EMIT_ERROR(ARG_val)</div><div class="ttdoc">Sets *err_code to ARG_val and logs a warning about the error using FLOW_LOG_WARNING().</div><div class="ttdef"><b>Definition:</b> <a href="error_2error_8hpp_source.html#l00202">error.hpp:202</a></div></div>
<div class="ttc" id="alog_8hpp_html_affcf2e4c496ce3f42adf981669c623b8"><div class="ttname"><a href="log_8hpp.html#affcf2e4c496ce3f42adf981669c623b8">FLOW_LOG_TRACE</a></div><div class="ttdeci">#define FLOW_LOG_TRACE(ARG_stream_fragment)</div><div class="ttdoc">Logs a TRACE message into flow::log::Logger *get_logger() with flow::log::Component get_log_component...</div><div class="ttdef"><b>Definition:</b> <a href="log_8hpp_source.html#l00227">log.hpp:227</a></div></div>
<div class="ttc" id="anamespaceflow_1_1net__flow_1_1error_html_a18e13de77b119ea0f2be411490859482a8f3a13ffefc4897da606c86e60a4422f"><div class="ttname"><a href="namespaceflow_1_1net__flow_1_1error.html#a18e13de77b119ea0f2be411490859482a8f3a13ffefc4897da606c86e60a4422f">flow::net_flow::error::Code::S_EVENT_SET_EVENT_ALREADY_EXISTS</a></div><div class="ttdeci">@ S_EVENT_SET_EVENT_ALREADY_EXISTS</div><div class="ttdoc">Attempted to add an event into an event set, but that event already exists.</div></div>
<div class="ttc" id="anamespaceflow_1_1net__flow_1_1error_html_a18e13de77b119ea0f2be411490859482a96f464959b6ce918048a2167c23f1c0b"><div class="ttname"><a href="namespaceflow_1_1net__flow_1_1error.html#a18e13de77b119ea0f2be411490859482a96f464959b6ce918048a2167c23f1c0b">flow::net_flow::error::Code::S_EVENT_SET_EVENT_DOES_NOT_EXIST</a></div><div class="ttdeci">@ S_EVENT_SET_EVENT_DOES_NOT_EXIST</div><div class="ttdoc">Attempted to work with an event that does not exist in the event set.</div></div>
<div class="ttc" id="anamespaceflow_1_1net__flow_html"><div class="ttname"><a href="namespaceflow_1_1net__flow.html">flow::net_flow</a></div><div class="ttdoc">Flow module containing the API and implementation of the Flow network protocol, a TCP-inspired stream...</div><div class="ttdef"><b>Definition:</b> <a href="asio_2node_8cpp_source.html#l00024">node.cpp:25</a></div></div>
<div class="ttc" id="anamespaceflow_1_1net__flow_html_ab9f537c84f77e9b8fa742fc5dc6d5693"><div class="ttname"><a href="namespaceflow_1_1net__flow.html#ab9f537c84f77e9b8fa742fc5dc6d5693">flow::net_flow::operator&lt;&lt;</a></div><div class="ttdeci">std::ostream &amp; operator&lt;&lt;(std::ostream &amp;os, const Congestion_control_selector::Strategy_choice &amp;strategy_choice)</div><div class="ttdoc">Serializes a Peer_socket_options::Congestion_control_strategy_choice enum to a standard ostream – the...</div><div class="ttdef"><b>Definition:</b> <a href="cong__ctl_8cpp_source.html#l00146">cong_ctl.cpp:146</a></div></div>
<div class="ttc" id="anamespaceflow_1_1util_html_a5d2247b715da63e4b960909561b90ae7"><div class="ttname"><a href="namespaceflow_1_1util.html#a5d2247b715da63e4b960909561b90ae7">flow::util::Lock_guard</a></div><div class="ttdeci">boost::unique_lock&lt; Mutex &gt; Lock_guard</div><div class="ttdoc">Short-hand for advanced-capability RAII lock guard for any mutex, ensuring exclusive ownership of tha...</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00265">util_fwd.hpp:265</a></div></div>
<div class="ttc" id="anamespaceflow_1_1util_html_a9c7a5df07c2e86c788de9e6bbaee77d5"><div class="ttname"><a href="namespaceflow_1_1util.html#a9c7a5df07c2e86c788de9e6bbaee77d5">flow::util::Mutex_recursive</a></div><div class="ttdeci">boost::recursive_mutex Mutex_recursive</div><div class="ttdoc">Short-hand for reentrant, exclusive mutex.</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00218">util_fwd.hpp:218</a></div></div>
<div class="ttc" id="anamespaceflow_1_1util_html_aa60d3ba517b5f5cf408faa92d269256a"><div class="ttname"><a href="namespaceflow_1_1util.html#aa60d3ba517b5f5cf408faa92d269256a">flow::util::chrono_duration_to_fine_duration</a></div><div class="ttdeci">Fine_duration chrono_duration_to_fine_duration(const boost::chrono::duration&lt; Rep, Period &gt; &amp;dur)</div><div class="ttdoc">Helper that takes a non-negative duration of arbitrary precision/period and converts it to Fine_durat...</div><div class="ttdef"><b>Definition:</b> <a href="util_2detail_2util_8hpp_source.html#l00031">util.hpp:31</a></div></div>
<div class="ttc" id="anamespaceflow_html_a29eaaa9d0fac4ce87d8b969222dbed09"><div class="ttname"><a href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">flow::Error_code</a></div><div class="ttdeci">boost::system::error_code Error_code</div><div class="ttdoc">Short-hand for a boost.system error code (which basically encapsulates an integer/enum error code and...</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00508">common.hpp:508</a></div></div>
<div class="ttc" id="anamespaceflow_html_a48799f1263cdeedec125be51a3db2b79"><div class="ttname"><a href="namespaceflow.html#a48799f1263cdeedec125be51a3db2b79">flow::Fine_duration</a></div><div class="ttdeci">Fine_clock::duration Fine_duration</div><div class="ttdoc">A high-res time duration as computed from two Fine_time_pts.</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00416">common.hpp:416</a></div></div>
<div class="ttc" id="anet__flow_2error_2error_8hpp_html"><div class="ttname"><a href="net__flow_2error_2error_8hpp.html">error.hpp</a></div></div>
<div class="ttc" id="anet__flow__fwd_8hpp_html"><div class="ttname"><a href="net__flow__fwd_8hpp.html">net_flow_fwd.hpp</a></div></div>
<div class="ttc" id="ashared__ptr__alias__holder_8hpp_html"><div class="ttname"><a href="shared__ptr__alias__holder_8hpp.html">shared_ptr_alias_holder.hpp</a></div></div>
<div class="ttc" id="atraits_8hpp_html"><div class="ttname"><a href="traits_8hpp.html">traits.hpp</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Mar 28 2025 22:55:35 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
